Skip to content
This repository was archived by the owner on Aug 27, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (26 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 1.01 KB
Raw

Contributing

TokenZero is a public runtime for recovery-aware context compression.

Public Scope

Contributions should stay inside the public product surface:

  • Runtime code in crates/.
  • Rust tests next to the owning crate.
  • Public docs in README.md and docs/.
  • Packaging metadata under package/ and packaging/.

Do not submit secrets, machine-local state, generated caches, unpublished planning notes, model checkpoints, or personal filesystem paths.

Do not add research dumps, audit trees, or planning RFCs to the public tree. Local-only attic (Pareto/, beads_compliance_audit/, ubs_audit/) is gitignored.

Development

Use Cargo for public runtime work.

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

Before a release branch is pushed, also run:

make release-check

For staged-only pre-commit checks:

git diff --check --cached

Use conventional commits, for example fix: preserve exact refs across restart.