All pages

Contributing

Working on the runtime.

rivethub-runtime is Rust only, under Apache-2.0. Read this before your first pull request; Contribution and support routes cover issues and proposals.

Build and check

cargo xtask install-hooks        # pre-commit and commit-msg hooks
cargo xtask check                # what CI runs first: fmt, clippy, dylint, cargo-deny, privacy, secrets
cargo clippy --workspace --all-targets --all-features -- -D warnings
cargo test --workspace
cargo build --release -p rivethub --bin rh -p cli --bin rivethub-migrate

The pre-commit hook runs the staged privacy check and cargo fmt; the commit-msg hook rejects attribution trailers.

The rules every change is held to

  • Crates depend only downward: foundation, kernel, adapters and services, composition. deny.toml fails the build when a Cargo.toml breaks that.
  • Production code has no comments, no allow, no unwrap or expect, and no unsafe.
  • clippy.toml disallows std locks, untyped JSON, runtime construction and environment reads outside their one home; a Dylint library carries the rest.
  • TLS stays on rustls. anyhow, OpenSSL and a second async runtime are banned.
  • The repository holds code and one README: no comments, no other Markdown, and no reason strings on lint expectations. What a change does and why goes in its commit message and pull request.

The lints in lints/ and the checks in xtask/ are the rules in full, and cargo xtask check runs all of them.

These docs

This site is plain static HTML generated with Node from src/pages.mjs. Its look comes from the shared RivetHub design system, vendored in vendor/design/. Fixes to the copy are welcome; check each claim against a published release first.

Want to try what you are changing?

Install a release and capture a session first.