Skip to content

Contributing

darkstar edited this page Oct 3, 2026 · 2 revisions

Contributing

🧩 Setup

git clone https://github.com/cybercore-tech/diagprint
cd diagprint
./scripts/install-hooks          # once per clone

πŸ“ Plan-first workflow

Rust implementation needs an Approved plan already committed in HEAD (the active plan is pointed to by .plans/ACTIVE); the pre-commit hook enforces it.

./scripts/plan new M4-causal-graph
# edit the generated plan
./scripts/plan approve
git add .plans/ && git commit
# …then implement, commit, and run the gates

βœ… Gates

./scripts/gate.sh precommit
./scripts/gate.sh fast
./scripts/gate.sh forensics
./scripts/gate.sh full

The hook checks staged whitespace and, for code changes, all-target/all-feature cargo check plus strict Clippy. CI stays authoritative. bacon.toml provides optional check, clippy, test, forensics and precommit jobs.

πŸ“ House rules

  • MSRV is Rust 1.85; CI checks all targets and features on it with MSRV-aware resolution.
  • Keep construction, identity, rendering, sources, remediation, history, forensics, Git provenance and capsules separate.
  • Never silently redefine a versioned schema; see Schemas & Specs.
  • Text files end with exactly one newline.
  • --no-verify is a human emergency hatch only; coding agents must not use it. Agent contract: AGENTS.md.

πŸ’¬ Where to talk

πŸ› Issues Β· πŸ’¬ Discord Β· βœ‰οΈ dev@cybercoretech.net

← πŸ§ͺ Examples Β Β·Β  πŸ—ΊοΈ Roadmap & Releases β†’

🩺 diagprint

⚑ Start

🧱 Build

πŸ“€ Ship

πŸ”§ Fix

πŸ”¬ Investigate

πŸ› οΈ Project


🌐 Site Β· πŸ“– docs.rs Β· πŸ“¦ crates.io

Clone this wiki locally