Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (35 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 1.78 KB
Raw

Contributing

Thank you for taking the time.

The branch flow

develop is the working branch and main is the release branch. Work happens on a branch cut from develop and reaches it through a pull request. main takes nothing but a release merge from develop, also through a pull request. Nothing is pushed directly to either.

Before you open a pull request

cargo fmt --all -- --check
cargo clippy --all-targets -- -D warnings
cargo build --all-targets
cargo test --all-targets
cargo test --doc

CI runs the last three on macOS, Linux and Windows; the first two are a separate lint job on ubuntu-latest only, so a formatting or clippy failure is reported once rather than three times. Windows is not optional: it is where a terminal renderer's assumptions break. cargo test --all-targets does not run doctests, which is why cargo test --doc is its own line.

What belongs here, and what does not

io-cli contains no agent loop, no provider client, no tool implementation, no sandbox, no policy engine and no session store. All of that is io-harness. If a change needs one of them, it is a change to the harness and this repository consumes it. A test in tests/dependencies.rs enforces this by inspecting the dependency set, so a pull request that adds an HTTP client, a TLS stack, a database crate or a sandboxing crate fails rather than being argued about in review.

Two more properties are asserted structurally and are not up for negotiation in a patch:

  • The alternate screen is never entered and the mouse is never captured.
  • No test asserts on wall-clock time. Measurements are recorded, never gated.

Licence

By contributing you agree that your contribution is licensed under Apache-2.0, the licence this project carries.