Skip to content

docs: add developer onboarding guide to CONTRIBUTING.md - #622

Open
woahwhattheheck wants to merge 4 commits into
Protocol-Guild:mainfrom
woahwhattheheck:wire/payd-561-contributing
Open

woahwhattheheck wants to merge 4 commits into
Protocol-Guild:mainfrom
woahwhattheheck:wire/payd-561-contributing

Conversation

@woahwhattheheck

Copy link
Copy Markdown

Closes #561

What

Replaces the three-line scaffold placeholder in CONTRIBUTING.md with a full contributor guide covering:

  • Architecture overview (frontend / backend / contracts / Stellar) with a simple diagram
  • Prerequisites and local setup for frontend, backend, and optional contracts
  • Environment and database configuration
  • Code style and standards (TypeScript/Rust, lint/format, typed errors, Apache-2.0)
  • Testing guide (Jest backend, Playwright frontend, Cargo contracts, CI expectations)
  • Pull request process and review criteria

Why

New contributors had no onboarding path beyond a leftover scaffold note. A real guide unblocks community setup and keeps PR quality consistent.

How tested

  • Manual review of the markdown against existing README, backend/.env.example, backend/frontend scripts, and .github/workflows/
  • Confirmed license guidance matches the Apache-2.0 LICENSE / Cargo workspace license

woahwhattheheck and others added 4 commits September 24, 2026 15:37
Replace the scaffold placeholder with setup instructions for frontend,
backend, and contracts, plus architecture overview, code standards,
testing guide, and PR process.

Closes Protocol-Guild#561
GitHub Actions does not accept retention-days on the workflow root.
That key is only valid on upload-artifact. The extra key made every
workflow fail validation on push before any job started.
GitHub Actions does not accept retention-days at the workflow root.
That made build, secrets-check, contract-release, and dapp-ipfs fail
with zero jobs on every push. Keep comments; set retention in repo settings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md with developer onboarding guide

1 participant