49 lines (34 loc) · 1.55 KB

Contributing

Thanks for contributing to Traverse.

Before You Start

Please read:

README.md
traverse-framework/.github — constitution, quality standards, antipatterns, compatibility policy, exception process, CLA (this repo has adopted governance version 1.0.0)

Core Rules

Approved specs are versioned, immutable, and merge-gating.
Contracts are the source of truth for runtime behavior.
Core runtime and business logic require 100% automated coverage.
Material architecture changes require an ADR.
Portability exceptions must be explicit and reviewed.
All contributions are governed by the CLA at traverse-framework/.github/CLA.md.

Workflow

Start from the governing approved spec.
Confirm whether an issue already exists.
Open or link the work item in the project board: GitHub Project
If needed, add or update an ADR before implementation.
Implement with tests and validation evidence.
Make sure the change passes the required validation flow.

Pull Requests

Every pull request should:

reference the governing spec version
reference the relevant issue or work item
explain any contract changes
explain any compatibility impact
explain any exception being used, if any

Pull requests should not merge if:

implementation drifts from spec
required tests or checks fail
a required ADR is missing

Issues

Use the issue templates when possible so work lands in the project board cleanly.