ed/manual_slop
Private
Public Access
0
0
Fork 0
Code Activity

feat(directives): harvest 5 code style directives from python.md + workflow.md + product-guidelines.md + AGENTS.md

Browse Source
This commit is contained in:
ed
2026-07-02 22:00:37 -04:00
parent a3e587280e
commit b5baaaaab7
5 changed files with 102 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
conductor/directives/no_diagnostic_noise/v1.md
+16
View File
@@ -0,0 +1,16 @@
# no_diagnostic_noise — v1
**Why this iteration:** Lifted verbatim from `conductor/code_styleguides/python.md` §8 (lines 68-70) + `AGENTS.md` "Session-Learned Anti-Patterns" §5. This is the baseline encoding — the imperative-bullet style currently in production.
Future variants will test alternative encodings (rationale-first, before/after) against this baseline.
**Source:** `conductor/code_styleguides/python.md:68-70 + AGENTS.md:"Session-Learned Anti-Patterns" §5`
---
From `conductor/code_styleguides/python.md` §8 "AI-Agent Specific Conventions":
- **No diagnostic noise in production code (Added 2026-06-09).** `sys.stderr.write(f"[XYZ_DIAG] ...")` lines added to `src/*.py` for one-time debugging are technical debt the moment they ship. The project's production code should not contain `[XYZ_DIAG]` markers, `print(...debug...)` calls, or any other ad-hoc debug instrumentation. The right place for diagnostic output during a one-time investigation is `tests/artifacts/<test_name>.diag.log` (a log file) or a standalone `/tmp/diag_<name>.py` script. If you must instrument a production function for a single test run, the diag lines are part of the same atomic commit as the fix — they do not live uncommitted in the working tree. If you "revert everything," that means the diag lines are also reverted.
---
From `AGENTS.md` "No Diagnostic Noise in Production (kill it)":
- Diagnostic stderr goes to a log file (`tests/artifacts/<test_name>.diag.log`) or to a temporary diagnostic script (`/tmp/diag_rag.py`), NOT to `src/*.py`. If you absolutely must instrument a production function for a single test run, the diag lines are part of the same atomic commit as the fix — they do not live uncommitted in the working tree. If you "revert everything," that means the diag lines are also reverted.