Thanks for contributing. This document describes the working agreement;
project structure and architecture live in docs/ and the
engineering rules in docs/PLANNING.md (§73 is binding).
git clone https://github.com/aliasfoxkde/OpenCodifier
cd OpenCodifier
just ci # fmt + clippy + test + doc + deny — must pass before every PR
just coverage # line coverage report (cargo llvm-cov)Commits follow Conventional Commits
(feat:, fix:, docs:, refactor:, test:, chore:); subject ≤ 50
chars, body wrapped at 72.
- Deterministic-first. Never add an ML inference path where a deterministic rule, filter, or cached result can decide with sufficient confidence (PLANNING.md §3).
- No placeholders. No
TODO/FIXME/unimplemented stubs land onmain; the workspace lints denyclippy::todoandclippy::unimplemented. - No
unwrap()/expect()/panic!in production paths; returnResult. Test modules may re-allow unwrap locally. corestays pure.opencodifier-coremust not gain dependencies on HTTP, MCP, CLI, Tokio, or any ML runtime (PLANNING.md §39).- Abstention is a feature. Never force a decision when confidence is insufficient; return an explicit abstain/escalate outcome.
- Raw probabilities are not confidence. Calibrated confidence requires the calibration layer; do not surface softmax output as final confidence.
- Document public APIs.
missing_docsis warn + CI-enforced-D warnings: undocumented public items fail the build. - Tests travel with behavior. Every fix or feature lands with tests
that fail without it. Schema changes land with fixtures under
fixtures/.
- Keep PRs scoped to one phase/concern; reference the PLANNING.md phase.
- CI must be green:
cargo fmt --check,cargo clippy -D warnings,cargo test --workspace,cargo test --doc,cargo deny check. - New public APIs need rustdoc with at least one example or invariant note.
By contributing you agree your work is released under the repository's Apache-2.0 license.