Contributing
How to contribute code or documentation, and where the full rules live.
The authoritative rulebook is
CONTRIBUTING.md. Read it before opening a pull
request. The Code of Conduct applies to all
participation.
Ways to contribute
- Report a bug or propose a feature with the repository's issue forms.
- Improve documentation: this site, the README, or a code comment that has become untrue.
- Fix a bug or add tests.
- Review pull requests.
Vulnerabilities go through the security policy, never a public issue.
Before you start
- Read Project status so your change fits the experimental scope.
- Read the invariants. A change that weakens one will not be accepted.
- Open an issue first for anything larger than a small fix.
Workflow in one paragraph
Branch from main as <type>/<short-description>, commit with Conventional Commits, run the relevant tests, and open a
pull request using the template. State every skipped check. See Contribution workflow.
Documentation changes
Docs live in two places and follow different rules. See Documentation governance and Writing documentation.
AI-assisted contributions
You are responsible for everything you submit, including output produced with an AI tool. Do not add AI attribution or
co-author trailers to commits. AI coding agents must follow
AGENTS.md.
Not available
GitHub Discussions are not enabled. Use issues for questions that are not sensitive. Conduct concerns go privately to the project maintainer, as described in the Code of Conduct; there is no moderation team.