Contributing Guide
Contributing Guide
Section titled “Contributing Guide”Contributions must preserve legal data trust and traceability
Section titled “Contributions must preserve legal data trust and traceability”Every contribution should improve the project without weakening schema integrity, auditability, or documentation consistency.
Before starting work
Section titled “Before starting work”- confirm scope is aligned with current roadmap priorities;
- ensure local setup is working;
- identify affected docs pages before coding.
Standard contribution workflow
Section titled “Standard contribution workflow”- create branch (
feat/SEN-XXX-description) - implement code/docs changes
- run validation commands (
lint,test, optionallybuild) - open PR to
main - include context and impact summary in PR description
Schema and legal-text safety checklist
Section titled “Schema and legal-text safety checklist”- avoid direct legal-text edits outside revision function;
- keep migration artifacts explicit and reviewable;
- ensure changes to schema behavior are documented.
Documentation expectations
Section titled “Documentation expectations”Contributors must update docs when changing:
- setup commands
- configuration
- feature status
- architecture assumptions
Review checklist
Section titled “Review checklist”A high-quality PR should answer:
- What changed?
- Why was it necessary?
- What validation was run?
- What docs were updated?