Contributing
All contributions welcome. PRs are checked by CI.
Run tests
Section titled “Run tests”nix flake check github:vic/checkmate --override-input target . -LFormat code
Section titled “Format code”nix run github:vic/checkmate#fmt --override-input target .Bug reports
Section titled “Bug reports”Create a minimal reproduction as a test case in checkmate/modules/tests/ and send a PR.
Failing tests are the best way to report bugs — they become the regression test once fixed.
Documentation
Section titled “Documentation”The docs site lives under ./docs/. Run locally:
cd docs && pnpm install && pnpm run devCommunity
Section titled “Community”- GitHub Issues — bugs and features
- GitHub Discussions — questions and ideas