writing-commit-messages
Write git commit messages for Tenzir repositories. Use when committing changes, running git commit, drafting commit messages, detecting staged changes, or asking about commit format and subject lines.
When & Why to Use This Skill
This Claude skill automates the creation of standardized, high-quality Git commit messages specifically tailored for Tenzir repositories. By enforcing strict formatting rules—such as imperative mood, character limits, and a focus on user-centric impact—it helps maintain a clean, professional, and searchable version control history that adheres to industry best practices.
Use Cases
- Drafting Professional Commits: Automatically generate concise subject lines and detailed bodies for staged changes, ensuring they meet the 50/72 character rule and use the correct imperative tone.
- Standardizing Team Workflow: Use the skill to refactor existing draft messages or notes into the Tenzir-specific format, ensuring consistency across a multi-developer codebase.
- Contextual Documentation: Create descriptive commit bodies that explain the 'what' and 'why' of a change rather than just the 'how,' making the project history more valuable for future audits and debugging.
- Issue Linking and Reference: Efficiently format commit messages to include issue references (e.g., 'Resolves: #123') and fixup instructions to streamline the code review and merging process.
| name | writing-commit-messages |
|---|---|
| description | Write git commit messages for Tenzir repositories. Use when committing changes, running git commit, drafting commit messages, detecting staged changes, or asking about commit format and subject lines. |
Commit Message Writing
Write clear, consistent git commit messages in Tenzir projects.
Format
<subject>
<body>
Subject line:
- Keep under 50 characters
- Use imperative mood ("Add feature" not "Added feature")
- Focus on user capability, not implementation
- Capitalize first letter
- No period at the end
Body (optional):
- Wrap at 72 characters
- Explain what and why, not how
- Separate from subject with blank line
Writing Style
Perspective: Write from users' capabilities and needs, not technical implementation.
Good: "Add DNS resolution operator" Bad: "Implement dns_lookup in libtenzir"
Voice: Active voice, present tense.
Good: "Fix crash when input file is empty" Bad: "Fixed a bug that was causing crashes"
Examples
Add slice function for substring extraction
Fix crash when input file is empty
The parser assumed at least one byte of input. Now it handles
empty files gracefully by returning an empty result.
Resolves: #456
Remove deprecated export command
Use `to` instead. The export command has been deprecated since v4.0.
Best Practices
- One logical change per commit—don't split a single change across commits
- Commit early and often; each commit should be a self-contained snapshot
- Order commits logically so dependencies appear in sequence
- Write for someone reading the log in 6 months
- Reference issues when relevant:
Resolves: #123orSee also: #456 - Use
git commit --fixup <SHA1>for corrections meant to be squashed