Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (76 loc) · 3.55 KB

CONTRIBUTING.md

File metadata and controls

100 lines (76 loc) · 3.55 KB

Contributing

This project is intentionally scoped as an MVP with obvious upgrade paths.

If you want to seed good open-source work quickly:

  1. Pick one of the drafts in docs/issues.
  2. Open it as a GitHub issue with the suggested labels.
  3. Tag whether it is good first issue, enhancement, or help wanted.

High-value contribution areas:

  • Wallet-authenticated payout flow
  • GitHub App or webhook integration
  • Soroban event indexing
  • Persistent relational storage
  • CI and integration tests.

Conventional Commits

We follow the Conventional Commits standard to keep the commit history clear and enable automated changelog generation.

Commit Format

<type>(<scope>): <subject>

<body>

<footer>

Rules:

  • Keep <subject> under 50 characters, lowercase, no period
  • Use imperative mood ("add" not "added")
  • The (<scope>) is optional but recommended for clarity

Commit Types

Type Purpose Example
feat New feature feat(frontend): add wallet connection UI
fix Bug fix fix(backend): correct bounty status transition logic
docs Documentation only docs(CONTRIBUTING): add commit message guide
test Test additions or fixes test(contract): add escrow release scenarios
refactor Code refactoring (no behavior change) refactor(backend): extract validation to schema
chore Tooling, dependencies, build scripts chore(deps): update Express to 4.18
perf Performance improvements perf(frontend): memoize bounty list rendering
ci CI/CD pipeline changes ci: add GitHub Actions workflow

Examples

Good:

feat(contract): implement release_bounty escrow transfer

Add on-chain token transfer logic when maintainer approves
bounty release. Validates contributor address and contract
balance before transfer.

Closes #42

Also good (for simple changes):

fix(api): reject negative bounty amounts

Pull Request Checklist

Before submitting a PR, verify:

  • Branch created from main — keep it focused on one issue
  • PR title follows conventional commits — e.g., feat(frontend): add wallet support
  • Tests pass locally
    • Frontend: npm run lint && npm run build (in frontend/)
    • Backend: npm run lint && npm run build (in backend/)
    • Contract: cargo test && cargo clippy (in contracts/)
  • No TypeScript errors — npm run build catches them
  • No debug code left behind
    • No console.log(), console.debug(), console.warn()
    • No // TODO comments without an associated issue
  • Documentation updated (if applicable)
    • API changes? Update ONBOARDING.md or in-code JSDoc
    • New feature? Add example to the relevant doc or README
    • Architecture change? Update docs/ARCHITECTURE.md
  • Commits use conventional format — squash if needed
  • PR description includes:
    • What changed and why
    • How to test/verify the change
    • Link to related issue(s): Closes #<issue-number>

Getting Help

We value quality contributions and clear communication. If this guide is missing something, a PR improving it is one of the most valuable contributions you can make.

Happy coding! 🚀