Private
Public Access
0
0

docs(styleguide): create stub conductor/code_styleguides/code_path_audit.md

5-convention outline. The full styleguide content goes in
Phase 12 (with the meta-audit + the 1-line extension).
This commit is contained in:
2026-06-22 00:42:59 -04:00
parent b83c07443d
commit 78c9d46336
@@ -0,0 +1,22 @@
# Code Path & Data Pipeline Audit Styleguide
> **Status:** Active convention as of 2026-06-22. Established by the `code_path_audit_20260607` v2 track.
This styleguide codifies the contract for `src/code_path_audit.py` v2 and the 6 input audit scripts it consumes. Companion to `data_oriented_design.md`, `error_handling.md`, `type_aliases.md`, and `agent_memory_dimensions.md`.
## The 5 Conventions (to be filled in Phase 12)
1. **Per-aggregate profile structure** (the 14 top-level fields).
2. **The 4 decomposition directions** (componentize, unify, hold, insufficient_data).
3. **The override file format** (`scripts/code_path_audit_overrides.toml`).
4. **The 4 mem dim classification rules** (curation, discussion, rag, knowledge, config, control, unknown).
5. **The cross-audit integration contract** (the 6 input JSON shapes; the 3-tier finding-to-aggregate mapping).
## See Also
- `conductor/tracks/code_path_audit_20260607/spec_v2.md` - the canonical spec
- `conductor/tracks/code_path_audit_20260607/plan_v2.md` - the canonical plan
- `conductor/code_styleguides/data_oriented_design.md` - the canonical DOD reference
- `conductor/code_styleguides/error_handling.md` - the `Result[T]` convention
- `conductor/code_styleguides/type_aliases.md` - the 10 TypeAliases + 1 NamedTuple
- `conductor/code_styleguides/agent_memory_dimensions.md` - the 4 mem dims