Contributing

Pull Requests

How to open a PR, what to expect in review, and the merge process.

PR process

  1. 1
    Fork and branch

    Fork the repo. Create a branch: git checkout -b feat/your-feature-name

  2. 2
    Make your changes

    Keep PRs focused — one concern per PR. Small PRs get reviewed faster.

  3. 3
    Test your changes

    Run validators, build the CLI, verify the UI. Include test steps in your PR description.

  4. 4
    Open the PR

    Open against main. Include: what changed, why, how to test, and screenshots for UI changes.

  5. 5
    Respond to review

    Maintainers will review within a few days. PRs with no response for 14 days may be closed.

  6. 6
    Merge

    Once approved, a maintainer will squash-merge your PR.

Checklist

  • My branch is up to date with main
  • I followed the commit convention
  • I ran the linter for my language
  • Validators pass for passing and failing states
  • I included screenshots for UI changes
  • The PR description explains what and why