Start with the manifesto. Bug reports, proposals, and documentation fixes are welcome.
Write issue and pull request titles and bodies in English, regardless of the language used to request the work. Keep quoted source text, logs, and code unchanged.
Search existing issues and PRs. For a feature or architectural change, open a proposal and agree on scope with the owner before implementation. A blank issue is fine if the form does not fit. Small fixes and documentation improvements can go straight to a PR.
Report reproducible problems with the bug form. For sensitive findings, follow Security.
- Create a focused branch from the latest
dev. Use your fork if you do not have write access. - Keep the change small enough to review as one unit. Coordinate edits that overlap someone else's work.
- Check the result and record what you ran. For documentation, read the rendered content, check links, and run
git diff --check; also usegit diff --cached --checkfor staged changes. For code, include relevant tests and evidence from the affected usage path. - Open a PR targeting
dev, explaining the problem, the change, and the verification. Link an existing issue when relevant; creating another issue just for the PR is unnecessary. - Address review feedback. The owner handles merging under the PR policy.
See the CI policy for automated and local checks.
By submitting original contributions for inclusion, you agree to offer them under the MIT License, unless separately agreed with the owner. Submit only material you have the right to contribute. Identify third-party material and its license in your PR, and preserve its original terms and notices.
- Issues: reports, proposals, and questions.
- Pull requests: scope, review, and merging.
- Releases: verification and publication.