Skip to content

CONTRIBUTING.adoc

Latest commit

 

History

History
22 lines (19 loc) · 1.07 KB

CONTRIBUTING.adoc

File metadata and controls

22 lines (19 loc) · 1.07 KB
Raw

Contributing

Please read CONTRIBUTING.adoc for the full contribution guidelines — what is accepted, what is not, the commit and PR conventions, the test layout, the documentation surface map, and the licence / SPDX policy. GitHub renders AsciiDoc directly.

If a quick orientation is enough:

  • Before you start: read README.md, RSR_COMPLIANCE.adoc, and CLAUDE.md (if you are using an AI agent).

  • Local setup: see QUICKSTART-DEV.adoc.

  • Tests: cargo test --lib, cargo test --tests, and idris2 --build src/abi/echidnaabi.ipkg for the ABI surface.

  • Commits: Conventional Commits, GPG-signed, atomic.

  • PRs: branch off main, rebase don’t merge, fill the template, auto-merge once green.

  • Banned: Python outside salt/, Dockerfiles (use Podman
    Containerfile), Make (use Justfile), believe_me / assert_total / unsafePerformIO / prim__crash in src/abi/, bare unsafe {} without // SAFETY: in Rust.