kunchenguid--no-mistakes/CONTRIBUTING.md

Contributing

Thanks for wanting to contribute. One rule up front:

All pull requests to this repository must be raised through no-mistakes.

This repo is no-mistakes. Contributions should be done using the tool itself, which reduces the maintainer's burden of reviewing and merging contributions. A GitHub Actions check (Require no-mistakes) runs on every PR and fails if the body is missing the deterministic signature that no-mistakes writes. PRs without it will not be reviewed or merged.

Workflow

1. Fork the repo, then clone the parent repo or set your local origin back to the parent repo (git@github.com:kunchenguid/no-mistakes.git).

2. Create a branch and make your changes.

3. Initialize or refresh the gate with your fork as the push target: no-mistakes init --fork-url git@github.com:<you>/no-mistakes.git.

4. Commit your changes.

5. Push through the gate instead of pushing to origin:

   git push no-mistakes
   

6. Run no-mistakes to attach to the pipeline, watch findings, and auto-fix or review as needed.

7. Once the pipeline passes, it pushes the branch to your fork and opens the PR against the parent repo for you.

See the quick start for the full first-run walkthrough.

Repo conventions

• Go 1.25+, standard toolchain. See AGENTS.md for agent instructions.
• Run make fmt, make lint, and make test before pushing. Run make e2e too when you touch agent integrations, the e2e harness, or recorded fixtures. The pipeline will run them again, but a fast local pass saves rounds.
• Run make skill when you change the canonical agent skill content under internal/skill; make lint fails if any committed no-mistakes skill file has drifted.
• Use make e2e-record only when an upstream agent wire format changes or you are adding a new fixture flavor. It overwrites internal/e2e/fixtures/, spends real API quota, and the diff should be reviewed before committing.
• Keep README.md high-level. Deep reference material belongs in docs/.
• Do not hand-edit CHANGELOG.md or .release-please-manifest.json. They are regenerated by release-please from your conventional commit messages, and a separate Generated files must not be hand-edited check will fail the PR if either is touched.

Questions

Open an issue, or talk to me on Discord.