Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (44 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

60 lines (44 loc) · 1.96 KB
Raw

Contributing to rust-RCP

Developer Certificate of Origin

All contributions must be signed off per the DCO. Add Signed-off-by: Your Name <[email protected]> to your commit message.

Code Style

  • Follow rustfmt defaults (cargo fmt --check is enforced in CI)
  • No warnings permitted (cargo clippy -- -D warnings must pass)
  • No unwrap() outside #[cfg(test)] blocks
  • #![forbid(unsafe_code)] — no unsafe Rust

Safety Requirements

Every functional change must:

  1. Annotate the relevant requirement: // fusa:req REQ-XXX
  2. Add or update a test annotated: // fusa:test REQ-XXX
  3. Pass rsfusa check with zero gaps

Testing

cargo test               # unit + integration tests
cargo test --release     # check optimised build
cargo clippy -- -D warnings
cargo fmt --check

Pull Request Process

  1. Fork and create a feature branch
  2. Write code with FuSa annotations
  3. Ensure all CI checks pass
  4. Open a PR against main
  5. Request review from at least one maintainer
  6. Safety-impacting changes require Safety Manager review

Versioning

Semantic versioning: MAJOR.MINOR.PATCH. See docs/SEMVER.md for the full policy, including:

  • Which modules carry a stability guarantee at all (not every pub item does pre-v1.0.0 — see that document's stability tiers), and the repo-specific rule that Cargo.toml's version does not move until the OPEN Alliance TC18 uplift (ROADMAP.md Milestones 1-10) reaches v1.0.0.
  • The #[non_exhaustive] policy for enums expected to grow.
  • If your change adds, removes, or renames a pub item, regenerate docs/PUBLIC_API.txt (cargo +nightly public-api --simplified > docs/PUBLIC_API.txt) and commit it in the same PR — CI's api-stability job fails otherwise.

Reporting Issues