Skip to content

Commit c34e4d4

Browse files
docs(standards): add critical rule 8 — update documentation when changing behavior
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 7f9abac commit c34e4d4

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ See DEVELOPMENT.md for the complete reference.
1212
5. **Write idempotent scripts.** Every script must be safe to re-run. Check before acting: `command -v tool || install_tool`, `mkdir -p`, guard file writes with existence checks.
1313
6. **Use the shared logging library.** No raw `echo` for status messages. Use `log_info`, `log_warn`, `log_error`, `log_debug`, and `die` from `lib/log.sh`.
1414
7. **Never suppress failing checks.** When a lint, format, security, or test check fails, fix the underlying issue. Never comment out code, add suppression annotations, disable rules, or mark CI jobs as allowed-to-fail to bypass a failing check.
15+
8. **Update documentation when changing behavior.** When a change affects public interfaces, configuration, CLI usage, or setup steps, update the relevant documentation (README, DEVELOPMENT.md, inline docs) in the same commit or PR. Do not leave documentation out of sync with code.
1516

1617
## Quick Reference
1718

0 commit comments

Comments
 (0)