Skip to main content
Version: next

Contributing

Contributions are welcome and appreciated.

Found something off?​

agnix validates against 145 rules, but the agent config ecosystem moves fast. If a rule is wrong, missing, or too noisy, we want to know.

Your real-world configs are the best test suite we could ask for.

Contribute code​

Good first issues are labeled and ready: good first issues

Adding a new rule is one of the best ways to get started. Each rule is a self-contained unit with clear inputs, outputs, and test patterns. Find a similar existing rule to use as your template.

Improve docs​

This documentation site is in website/. To run locally:

npm --prefix website ci
npm --prefix website run generate:rules
npm --prefix website start

Where canonical content lives​

Long-form source-of-truth docs remain in the repository:

  • README.md
  • SPEC.md
  • knowledge-base/

This website assembles and links that content for navigation and search.

References​