commit-message-rules

Name: commit-message-rules
Availability: InStock
Author: elecdeer

Check commit messages against project rules and Conventional Commits format.

Updated Nov 1, 2021

Search Tags:#git #version control #conventional commits #commit messages #code history

Ready to run

npx skills add https://github.com/elecdeer/dotfiles --skill commit-message-rules

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: commit-message-rules
Source: https://github.com/elecdeer/dotfiles/tree/main/dot_claude/skills/commit-message-rules
Command: npx skills add https://github.com/elecdeer/dotfiles --skill commit-message-rules

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill helps users maintain clear and consistent commit messages, which is crucial for understanding and managing code history in a team environment.

Core Features & Use Cases

Project-Specific Rules: Checks for and applies project-specific commit message conventions.
Language Matching: Ensures commit messages are written in the same language as the existing commit history.
Conventional Commits: Defaults to using Conventional Commits format for simplicity.
Avoiding BREAKING CHANGES: Provides guidance on when to use BREAKING CHANGE labels.
One-Line Messages: Suggests keeping messages concise when the change is obvious.
Continuation Work: Recommends amending or rebasing for continuation work to maintain a clean history.
Commit Signing: Ensures 1Password SSH commit signing is not bypassed.

Quick Start

Use the commit-message-rules skill to review and finalize your commit message for the current changes.

Frequently Asked Questions about commit-message-rules

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I enforce consistent git commit messages in a team environment?▼

To enforce consistent git commit messages, you can apply project-specific rules and use the Conventional Commits format. This ensures readability and maintainability across team development workflows.

How do I format git commit messages for continuation work?▼

For continuation work, you should keep messages concise and use amending or rebasing. This approach maintains a clean code history by avoiding fragmented or repetitive commits.

Does Conventional Commits format require using BREAKING CHANGE labels?▼

No, Conventional Commits format does not require using BREAKING CHANGE labels. You should avoid unnecessary BREAKING CHANGES and only use them when genuinely needed to indicate major impacts.

How do I match the language of existing git commit messages?▼

To match the language of existing git commit messages, you can check the project history and ensure new messages are written in the same language. This maintains consistency across the codebase.

Can I bypass 1Password SSH commit signing when finalizing commits?▼

No, you should not bypass 1Password SSH commit signing. Ensuring commit signing is active provides an additional layer of security and authenticity for your code history.