Skip to Content
AutoMode

Contribute to AutoMode

Five ways to help AutoMode, from a two-minute bug report to a benchmark task. Your first pull request in four steps, and the rules every change follows.

AutoMode gets better when more people use it on more kinds of work. It is MIT licensed, every line is in the repository, and you can add a benchmark task, a judge case or a risk rule in under ten minutes. No contribution is too small. A fixed sentence counts.

Five ways to contribute: a benchmark task, a judge case, a risk rule, docs and images, a bug report

You want toDo thisTime
Report a bugOpen an issue. Say what the bar showed and what you expected.2 min
Add a judge caseAdd a prompt and the efforts a careful person accepts to bench/judge-cases.json.10 min
Add a risk ruleAdd a pattern to hooks/lib/risk.ts and a test in tests/.30 min
Add a benchmark taskPick a public MIT or Apache-2.0 repository, pin two commits, and add a task file. Run node bench/validate-fixture.mts <id>.1 to 2 hours
Improve the docsEdit a page in site/content/docs/, or add a real screenshot to docs/readme/. Every page has an edit link.5 min

Your first contribution

Fork and clone

Fork the repository and clone your fork.

Check that main passes

Run npm install, then npm run check. Every check passes on main.

Make one small change

Add or update a test with it.

Open a pull request

Say what changed and why. The body must contain Closes #N.

Rules

  • Do not commit secrets, keys, personal paths or private data. Test fixtures use fake values.
  • Do not commit real session transcripts, or the text of model replies in bench/results/.
  • Add or update a test with every behavior change.
  • Keep one task per branch and per pull request.
  • Write comments and docs in short sentences, in active voice, with one idea per sentence.
  • Do not claim a cost saving without a benchmark run that others can repeat.

Look for issues labeled good first issue. Ask questions in Discussions. The full guide is CONTRIBUTING.md.

Last updated on

On this page