Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (38 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 1.68 KB
Raw

Contributing

Contributions must preserve the crate's ownership and cleanup contracts.

Before opening a change

Use the bug, feature, or question issue form when discussion would help define the expected behavior. Report suspected vulnerabilities through GitHub private vulnerability reporting, not a public issue.

Keep pull requests focused. Changes to ownership, handle inheritance, Job lifetime, ConPTY, mitigation, quoting, or suspended-process behavior should explain the safety invariant they preserve.

Development environment

Development and integration tests require Windows 10 version 1809 or later. The crate supports Rust 1.75 and later. Install the tool versions used by CI, then run:

just ci
just coverage

Before submitting, also run:

actionlint
git diff --check
gitleaks git . --redact --no-banner
gitleaks dir . --redact --no-banner

just release-candidate validates packaging and reproducibility locally; it does not publish anything.

Code and documentation expectations

  • Preserve the documented ownership and cleanup behavior, including on errors.
  • Give every unsafe block a specific safety justification.
  • Add deterministic tests for behavior changes and avoid timing-only assertions.
  • Keep the public API snapshot unchanged unless the pull request changes the public API and explains the compatibility impact.
  • Update the crate documentation, ADRs, or security boundary when contracts change.
  • Keep dependencies minimal and compatible with the MSRV.

Required checks and review conversations must be complete before merge. Pull requests are squash-merged into main.