Skip to Content
ContributingOverview

Contributing

RantAIClaw is open source under the GNU Affero General Public License v3.0 (AGPL-3.0). Contributions follow a documented protocol described in detail in the rantaiclaw repo:

High-level rules

  • One concern per PR. No mixed feature + refactor + infra patches.
  • Read before write. Inspect the relevant module, factory wiring, and adjacent tests before editing.
  • Validate by risk tier. Docs/chore changes are light; security / runtime / gateway / tools changes need risk notes and rollback plans.
  • Keep change reversible. Small scope, clear blast radius.
  • Privacy: never commit personal data, real names, real tokens, or private URLs in code, docs, tests, fixtures, or commit messages.

Validation matrix

Default local checks for code changes:

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

Preferred local pre-PR validation path:

./dev/ci.sh all

Contributing to these docs

The docs site (this repo, RantAIClaw-Docs ) is separate from the rantaiclaw source. PRs that change behavior in rantaiclaw should typically come with a follow-up PR here.

For now, content is hand-written MDX. The plan is to introduce generation scripts for the reference layer (CLI, config schema, tools registry) over time so reference content cannot drift from the code.

Last updated on