Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.31 KB

Contributing

This repository is a formal-design research artifact with an executable consumer prototype. Contributions are welcome, but please read these notes first.

Before you start

  • Read README.md, spec/GATES.md, and spec/VERSIONING.md. Work outside the admitted scope in spec/GATES.md §11 and spec/VERSIONING.md should be discussed in an issue first.
  • spec/ is normative and wins every disagreement. machine/ and lean/ are derived transcriptions; where they disagree with spec/, spec/ wins and the transcription is fixed.
  • Decisions are recorded in the pull request or release notes (CHANGELOG.md), not accreted into the artifact they concern.

How to contribute

  1. Open an issue describing the change before large work.
  2. Branch from main; keep changes focused (one concern per branch/PR).
  3. Run sh scripts/lint_docs.sh and python -m pytest -q machine/ before submitting.
  4. Open a pull request; maintainers review and merge. Do not merge your own PR.

Normative changes

Changes to spec/, claim statuses, gates, or scope require a pull request with one approving review and a dated decision record (pull request description or release note).

License

By contributing, you agree your contributions are licensed under the Apache License, Version 2.0 (see LICENSE).