Start with the guide's contributing section, published at
https://gpillon.github.io/ignis/contributing/ and readable here under
docs/user/contributing/: the ground
rules, the repository's layout, building from source, the tests and the GPU
discipline, make, and how work is tracked.
In short:
- Working in a fork: send upstream what is not about your setup, a fix, a feature or a card's figures (Working in a fork).
- Report a bug or ask for a feature in a GitHub issue:
the command you ran (or
make config's output), what you expected, what happened, and the server's log lines around it. - Every code change ships with a test; while working, run only the change's
own tests, and the work is done when
cargo testpasses workspace-wide on CI, with the branch pushed asci/<n>. - Every user-visible change updates the user guide,
docs/user/, in the same commit (docs/agents/user-docs.md). - One run at a time on the GPU:
make gpu-statusbefore any of them. - The rules a review holds a diff to are in
CODING_STANDARDS.md. - The conventions agents follow — and humans too — are in
AGENTS.mdanddocs/agents/.