Skip to content

ZIR-000: Add commit message format documentation and tooling#327

Open
zeroecco wants to merge 1 commit intomainfrom
standardize-commit-messages
Open

ZIR-000: Add commit message format documentation and tooling#327
zeroecco wants to merge 1 commit intomainfrom
standardize-commit-messages

Conversation

@zeroecco
Copy link
Copy Markdown

@zeroecco zeroecco commented Apr 4, 2026

Summary

This PR adds comprehensive documentation and tooling to standardize commit messages across the Zirgen project.

Changes

  • CONTRIBUTING.md: Added detailed commit message format guidelines

    • Documents the required ZIR-XXX: Description format
    • Provides examples of good and bad commit messages
    • Explains special cases (merge commits, reverts)
    • Includes testing and troubleshooting tips
  • scripts/install-commit-msg-hook.sh: Installation script for commit message validation

    • Sets up the existing commit-msg hook
    • Configures a commit message template
    • Makes it easy for contributors to set up validation locally
  • .git/commit-msg-template: Commit message template

    • Pre-filled template with format examples
    • Opens automatically when running git commit (without -m)
    • Helps developers write properly formatted messages

Background

The commit-msg hook already exists in the repository at .git/hooks/commit-msg and enforces the ZIR-XXX format. This PR adds the documentation and tooling to make it easier for contributors to:

  1. Understand the commit message requirements
  2. Install the validation hook locally
  3. Use the template to write correct messages

Testing

To test the installation script:

./scripts/install-commit-msg-hook.sh

To test the hook validation:

echo "ZIR-123: Test message" | .git/hooks/commit-msg /dev/stdin

🤖 Generated with Claude Code

Related:

Adds comprehensive documentation and tooling to standardize commit
messages across the project. This includes:

- CONTRIBUTING.md with detailed commit message format guidelines
- Installation script for the existing commit-msg hook
- Commit message template to help developers write proper messages

The commit-msg hook was already in place and enforces the ZIR-XXX
format. This change adds documentation and makes it easier for
contributors to set up the validation locally.

Nightshift-Task: commit-normalize
Nightshift-Ref: https://github.com/marcus/nightshift

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
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