Git Commit Convention

Git Commit Convention Skill

This skill provides guidelines for writing consistent and meaningful Git commit messages following the Conventional Commits specification with enhanced professional terminology formatting.

Overview

Conventional Commits is a specification for adding human and machine readable meaning to commit messages. It makes it easier to write automated tools on top of the commit history. This enhanced version emphasizes proper formatting of technical terms using backticks.

Commit Message Format

Each commit message consists of a header, an optional body, and an optional footer.

<type>(<scope>): <subject> #<issue> !<mr|pr>

[optional body]

[optional footer(s)]

Header (Required)

The header is mandatory and must conform to the format:

<type>(<scope>): <subject> #<issue> !<mr|pr>

• type: Required. Describes the kind of change.
• scope: Optional. Describes the module/component affected.
• subject: Required. A brief description of the change.
• issue: Optional. Issue ID prefixed with # (e.g., #123).
• mr|pr: Optional. Merge Request or Pull Request ID prefixed with ! (e.g., !456).

Types

Type Aliases

The following types from kazupon/git-commit-message-convention are also supported as aliases:

Scope (Optional)

The scope should be the name of the module/component affected. Examples:

• core
• api
• ui
• auth
• config
• deps

Subject (Required)

• Use the imperative, present tense: "change" not "changed" nor "changes"
• Don't capitalize the first letter
• No dot (.) at the end
• Keep it under 72 characters
• Wrap technical terms with backticks: Function names, class names, variables, methods, etc.

Good Examples:

• feat(auth): add `OAuth2` login support
• fix(api): resolve `null` pointer exception in `UserService
• docs(readme): update `install()` instructions
• feat(auth): add `OAuth2` login support #123
• fix(api): resolve `null` pointer in `userService` #456 !789
• chore(deps): update `webpack` to v5 #100 !200

Bad Examples:

• feat(auth): add OAuth2 login support (technical term not wrapped)
• fix(api): resolve null pointer exception (keywords not wrapped)
• feat: Added OAuth2 login support. (capitalized, ends with dot)

Issue Reference (Optional)

Add issue ID prefixed with # to link the commit to a specific issue:

• Format: #<issue-number>
• Example: feat(auth): add login #123

MR/PR Reference (Optional)

Add Merge Request or Pull Request ID prefixed with ! to link the commit:

• Format: !<mr|pr-number>
• Example: feat(auth): add login #123 !456

Body (Optional)

• Use the imperative, present tense
• Should include the motivation for the change and contrast with previous behavior
• Separate from subject with a blank line
• Wrap all technical terms with backticks: Function names, class names, variables, methods, file names, commands, etc.
• Use backticks for code snippets: Inline code examples should be wrapped
• Be specific about technical changes: Mention exact function names, classes, and modules

Example:

feat(auth): add `OAuth2` login support

Implement `OAuth2` authentication flow to allow users to sign in with
third-party providers. This replaces the previous `BasicAuth` mechanism
which was less secure and harder to maintain.

The implementation supports `Google`, `GitHub`, and `Microsoft` providers.
New functions added:

- `authenticateWithProvider()`
- `handleCallback()`
- `getUserInfo()`

Footer (Optional)

The footer can contain:

• Breaking changes: Start with BREAKING CHANGE: followed by description
• Issue references: e.g., Closes #123, Fixes #456

Breaking Change Example:

refactor(core): rename configuration options #200 !300

BREAKING CHANGE: Configuration options have been renamed for clarity:

- `maxItems` is now `maxLimit`
- `showAll` is now `displayAll`

Update your configuration files accordingly.

Professional Terminology Formatting Guide

When to Use Backticks

Wrap the following technical elements with single backticks:

1. Function/Method Names: calculateTotal(), getUserData
2. Class/Component Names: UserService, ButtonComponent
3. Variable/Property Names: userId, isLoading
4. File/Path Names: package.json, /src/utils/helpers.js
5. Commands/Tools: npm install, git commit
6. Keywords: null, undefined, this, async, await
7. Configuration Options: maxRetries, timeout
8. HTTP Methods: GET, POST, PUT, DELETE
9. Status Codes: 200, 404, 500
10. Library/Framework Names: React, Vue, Express

Examples of Proper Formatting

Before (Poor):

fix(api): handle undefined values in user service

Fixed a bug where the application would crash when user data was missing.
The getUserData function now properly validates responses and returns
default values instead of crashing.

After (Enhanced):

fix(api): handle `undefined` values in `UserService`

Fixed a bug where the application would crash when user data was missing.
The `getUserData()` function now properly validates responses and returns
default values instead of crashing.

Added null checks for `userId` and `email` properties.

Complete Examples

Simple Commit with Technical Terms

fix(button): resolve `click` event not firing on `iOS`

Commit with Issue Reference and Technical Terms

feat(auth): add `OAuth2` login support #123

Commit with Issue and MR/PR Reference

fix(api): resolve `null` pointer in `UserService` #456 !789

Commit with Body and Extensive Technical Formatting

feat(dropdown): add `keyboard` navigation support #101

Users can now navigate dropdown options using arrow keys and select
with `Enter`. This improves accessibility and user experience for
keyboard-only users.

New methods implemented:
- `handleKeyDown()`
- `selectOption()`
- `closeDropdown()`

Event listeners added for `keydown` events on `dropdown-container`.

Breaking Change with Technical Details

refactor(core): rename configuration options #200 !300

BREAKING CHANGE: Configuration options have been renamed for clarity:
- `maxItems` is now `maxLimit`
- `showAll` is now `displayAll`

Update your `config.json` files accordingly.
The `initConfig()` function signature has changed.

Multiple Issues with Technical Context

fix(parser): handle malformed `JSON` input #123 !456

Add validation to prevent crashes when parsing invalid `JSON` data.
The `parseData()` function now uses `try-catch` blocks and returns
`null` for invalid inputs.

Fixes #123
Closes #456

Best Practices

1. Be Specific: Vague messages like "fix bug" or "update code" are unhelpful.

2. Keep It Short: Subject line should be under 72 characters.

3. Use Imperative Mood: Write as if you're giving a command: "add feature" not "added feature".

4. Explain Why, Not What: The diff shows what changed; the message should explain why.

5. Reference Issues: Link to relevant issues, PRs, or tickets.

6. Atomic Commits: Each commit should represent one logical change.

7. Format Technical Terms: Always wrap technical elements with backticks for clarity.

8. Consistent Formatting: Apply the same formatting rules across all commits.

9. Professional Language: Use precise technical terminology appropriate for the domain.

Tools Integration

This convention works well with:

• commitlint: Lint commit messages
• standard-version: Automatic versioning and CHANGELOG generation
• semantic-release: Full automated release workflow
• conventional-changelog: Generate changelogs from commit history

commitlint.config.js Example

module.exports = {
    extends : ['@commitlint/config-conventional'],
    rules   : {
        'type-enum'         : [2, 'always', [
            // Recommended types
            'feat',
            'perf',
            'breaking',
            'fix',
            'security',
            'cosmetic',
            'cos',
            'exception',
            'test',
            'docs',
            'doc',
            'refactor',
            'lint',
            'style',
            'typo',
            'chore',
            'ci',
            'build',
            'release',
            'revert',
            // Type aliases
            'new',
            'feature',
            'bug',
            'performance',
            'improvement',
            'deprecated',
            'examples',
            'dependency',
            'config',
            'update',
            'wip',
        ]],
        'subject-case'      : [2, 'never', ['upper-case']],
        'subject-full-stop' : [2, 'never', '.'],
        'header-max-length' : [2, 'always', 72],
    },
};

package.json Scripts

{
  "scripts" : {
    "commit"       : "cz",
    "release"      : "standard-version",
    "release:beta" : "standard-version --prerelease beta"
  }
}

References

• Conventional Commits
• Angular Commit Message Guidelines
• commitlint
• standard-version