Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (39 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

51 lines (39 loc) · 1.91 KB
Raw

Contributing

Setup

mix setup     # fetches dependencies and installs the git hooks

The hooks enforce the quality gates: compile with warnings-as-errors, formatting, a secret scan, and regression checks against .claude/gate-baseline.json for the test, credo and dialyzer counts. They are policy, not a security control -- --no-verify bypasses any hook.

Documentation index: docs/README.md.

Ground rules

  • Work from repo state, not remembered chat context.
  • Prefer small, direct changes over parallel feature paths.
  • Keep the demo bounded, local-first, and honest.
  • Do not add placeholder security claims or fake integrations.

Code change discipline

  1. Check the current task list.
  2. Change the smallest correct layer.
  3. Reuse existing demo runners, tasks, and views when they already exist.
  4. Run the narrowest meaningful verification after each change.
  5. Update docs when behavior or operator expectations change.

Verification discipline

  • Format before reporting completion.
  • Run focused tests first.
  • For integration-tagged tests, include the tag explicitly when needed.
  • Report exact commands run and any exclusions/limitations.

Demo discipline

  • Preserve bounded terminal output.
  • Keep demo language explicit about simulation and local-only scope.
  • Do not imply production readiness.

License

This project is licensed under the Apache License, Version 2.0. By submitting a contribution you agree that it is licensed under those same terms, per Section 5 of the license. Do not submit code you are not authorized to license this way.

Branch protection

main is protected by an active ruleset with no bypass actors, so the rules apply to administrators too. Force-pushes and branch deletion are blocked, changes land through a pull request, and all nine Gate - jobs must pass with the branch up to date before a merge is possible. A red commit cannot reach main.