Sources:
AGENTS.md
CONTRIBUTING.md
ai/project-map.yml
ai/test-matrix.yml
commit d32b9cc880a8
docs-explanation
Common contribution tasks¶
Start with the root AGENTS.md, then read the nearest nested instructions. Use
this table to find an entry point; confirm every path and command at the source
commit you are changing.
| Goal | Inspect | Validate first |
|---|---|---|
| Fix C++ behaviour | Owning src/ type, callers, related tests/ |
C++ format and focused Catch2 test |
| Add JSON content | Similar current data plus loader/factory | JSON format, full load, ID checks |
| Change an EOC | EOC data, parser registration, talker/context tests | JSON load and focused EOC parse/test |
| Change Lua v5 | Manifest Schema, LuaLS, native registration, inventories | Declaration, parity, coverage, examples |
| Update a bundled mod | modinfo.json, dependencies, interactions |
Load that mod and supported combinations |
| Diagnose a build | Exact platform, preset/options, first failure | Rerun the narrow failed stage |
| Port upstream | Exact source commit/PR and CCB divergence | Focused behaviour plus compatibility checks |
| Change docs | Catalog entry and declared source paths | Generate/check, strict build, internal links |
Before opening a pull request¶
- Review the final diff for unrelated changes, generated files, caches, credentials, and machine-specific paths.
- Name the Responsible human and provide a useful Summary.
- Separate Passed, Failed, and Not run; include platform and exact commands.
- Complete Documentation impact, Related CCB-Docs PR, Affected documentation IDs, and Generated reference impact.
- For compatibility-sensitive changes, state save, ID, mod, Lua API, and platform implications explicitly.
For more detail, use the experienced contributor index, project map, and validation quickstart.