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

feat(directives): add rule-statement header to 33-40 of 66 v1.md files

Browse Source
This commit is contained in:
ed
2026-07-03 09:45:48 -04:00
parent e9275236f2
commit ead7cf2869
8 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
conductor/directives/no_diagnostic_noise/v1.md
+2
View File
@@ -1,3 +1,5 @@
# Diagnostic stderr writes [XYZ_DIAG] in src/*.py are technical debt; use tests/artifacts/<name>.diag.log or /tmp/diag_*.py
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.