Skip to main content

Contributing

Thanks for considering a contribution. For anything larger than a small fix, open an issue first so the scope is agreed before you write the code.

See Development setup for the local loop and the four checks a PR must pass.

Screenshots and sample data​

Screenshots and sample data must come from public datasets only (for example COCO val2017). Never commit an image from a private dataset, a photograph of a person or vehicle you don't have the rights to, or a screenshot showing a real deployment's hostnames, paths, or class counts. See Screenshots.

Commit messages​

Conventional commits: <type>(<scope>): <summary>, imperative mood. Types: feat, fix, docs, style, refactor, test, build, chore, security, perf. Update CHANGELOG.md under [Unreleased] for anything user-visible.

Reporting bugs / requesting features​

Use the issue templates — they ask for what's actually needed to reproduce or scope the work.

Code of conduct​

Be respectful and constructive. Disagreements about approach are fine and expected; personal attacks are not.