Skip to content

ZIR-000: Document commit message convention in CLAUDE.md and CONTRIBUTING.md - #360

Open
zeroecco wants to merge 1 commit into
mainfrom
commit-normalize/docs-v3
Open

zeroecco wants to merge 1 commit into
mainfrom
commit-normalize/docs-v3

Conversation

@zeroecco

@zeroecco zeroecco commented Jun 4, 2026

Copy link
Copy Markdown

Summary

  • Adds CLAUDE.md with AI-agent guidance covering the ZIR-NNN: commit message convention
  • Adds CONTRIBUTING.md with full contributor documentation: pattern, valid/invalid examples, the ZIR-000 fallback, Merge/Revert exceptions, and honest enforcement notes
  • Both files explicitly state that .git/hooks/ is not tracked and hooks are not installed automatically on clone — no CI enforcement currently exists

What was corrected vs prior iterations

  • Does not claim hooks auto-install on clone (fixed from iteration 1)
  • Does not reference or link to hook scripts as if they exist in tracked paths (fixed from iteration 2)
  • Does not fabricate CI enforcement that does not exist
  • Documents only the convention itself and the current (manual/voluntary) enforcement reality

Test plan

  • Verify CLAUDE.md accurately describes the ZIR-NNN pattern, ZIR-000 fallback, and exceptions
  • Verify CONTRIBUTING.md contains no false claims about hook installation or CI enforcement
  • Verify no other files were modified

🤖 Generated with Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant