This file is a short, practical guide for contributors.
- Create a dedicated branch for each topic or pull request.
- Keep changes minimal and focused on one problem.
- Build and run relevant verification before pushing.
- Draft commits locally first.
- Push only after you are ready for review OR mark your PR as "draft" if it is still WIP.
- Use clear commit titles with subsystem and intent.
- Include what changed, why, and how it was verified.
- Include author signature trailers as required by the project process.
- Prioritize behavior and regression risks over style-only feedback.
- For parser code, validate boundary handling and diagnostics.
- Prefer high-value checks over defensive bloat.
- Confirm build succeeds.
- Run table-specific round-trip checks when touching compiler/disassembler logic.
- Run broader tests when appropriate for scope and risk.
For detailed rules, see:
- docs/style.md
- docs/testing.md
- docs/table-parser-validation.md
- docs/pr-workflow.md