Skip to content

Contributing

Iteron welcomes focused bug fixes, tests, provider evidence, terminal compatibility work, documentation, and design discussion. Human contributors remain accountable for changes produced with or without coding agents.

Choose an entry path

  • Small documentation or reproducible bug fixes may go directly to a pull request.
  • Behavior, public interface, security-boundary, protocol, or cross-module work should start with an issue or Discussion.
  • Vulnerabilities use the private security route.
  • Ongoing module responsibility uses an ownership-claim issue; a contribution does not require becoming a maintainer.

Read the complete CONTRIBUTING.md and Code of Conduct before opening a pull request.

Local start

git clone https://github.com/YOUR-ACCOUNT/Iteron.git
cd Iteron
cargo build --locked -p iteron-cli
cargo test --workspace --all-targets --locked

Default tests need no provider credential. Linux contributors should install a usable bubblewrap so the live confinement test runs.

Required evidence

cargo fmt --all -- --check
cargo run --locked -p iteron-xtask -- boundaries check
cargo check --workspace --all-targets --locked
cargo clippy --workspace --all-targets --locked -- -D warnings
cargo test --workspace --all-targets --locked

Behavior changes need a regression or integration test. TUI rendering changes need semantic and terminal evidence. Do not include real credentials, private sessions, proprietary source, generated-by trailers, or unrelated cleanup.

Start with the development setup, testing guide, and review process.