Skip to content

Latest commit

 

History

History
36 lines (30 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

36 lines (30 loc) · 1.85 KB

Contributing

Read AGENTS.md and START_HERE.md. Keep changes small enough to review against a concrete user outcome. No mandatory dependency install is needed for the optional Python helper.

Before submission:

python tools/exec_ctrl.py validate
python -m unittest discover -s tests -v
git diff --check

Change normative guidance before adapting examples and evidence records. Add tests for behavioral changes to routing, parsing, policy composition or evidence checks; do not add tests that only assert prose contains a preferred sentence. Check the entry contract's reading budget and inspect version/migration boundaries. Keep VERSION, catalog, activation entry, the README's bold current-version marker, newest changelog heading and active example records on the same version. Preserve historical changelog entries and evidence records with their original identities. Verify generated pending records and example policies as well as changed commands. Test denial, stale identity, malformed input and read-only behavior for new helper capabilities. Explicit-file snapshots must disclose their bounded scope; never auto-read secrets or execute commands to infer project facts. The test guide describes the reproducible synthetic project workflow, CLI side-effect guard, platform skips and publication acceptance limits. All these checks run through ordinary unittest discovery in the existing CI matrix.

For provider-specific behavior, cite dated official documentation and distinguish documentation support from observed field results. Update the field-trial record only after running a real scenario. Do not mark the entire framework secure or compliant from these checks.

Review the final diff for secrets, accidental generated files and changes outside scope. Follow the repository's actual review and publishing authorization.