Making Git Commits

Making Git Commits

Overview

Git commits follow the Conventional Commits specification for consistent, parseable history.

Core principle: Every commit message is structured as type(scope): description with optional body and footer.

When to Use

• Making a new commit
• Amending an existing commit
• User says "commit", "save changes", "commit this"
• After completing a task that should be committed
• Squashing or rewriting commits

Commit Message Format

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Type (Required)

Scope (Optional but Recommended)

The scope provides context about what part of the codebase is affected:

• Module name: feat(auth): add login
• File/component: fix(header): correct alignment
• Area: docs(readme): update installation

Description (Required)

• Use imperative mood: "add" not "added" or "adds"
• Lowercase first letter
• No period at the end
• Max 50 characters (hard limit: 72)
• Complete the sentence: "This commit will..."

Body (Optional)

• Separated from description by blank line
• Wrap at 72 characters
• Explain WHAT and WHY, not HOW
• Use when description alone isn't sufficient

Footer (Optional)

• Breaking changes: BREAKING CHANGE: description
• Issue references: Closes #123, Fixes #456
• Co-authors: Co-authored-by: Name <email>

Quick Reference

# Feature
git commit -m "feat(users): add password reset flow"

# Bug fix
git commit -m "fix(api): handle null response gracefully"

# Breaking change
git commit -m "feat(api)!: change response format" -m "" -m "BREAKING CHANGE: response now returns array instead of object"

# With body
git commit -m "refactor(core): extract validation logic" -m "" -m "Moved validation from controller to dedicated service for reuse across endpoints."

# Amend last commit
git commit --amend -m "fix(auth): correct token expiry check"

The Gate Function

BEFORE executing any git commit:

1. STAGE: Verify correct files staged (`git status`)
2. TYPE: Select appropriate commit type from table
3. SCOPE: Identify affected area (if applicable)
4. DESCRIPTION: Write imperative, lowercase, <50 chars
5. REVIEW: Read full message - does it explain the change?
6. COMMIT: Execute the commit command
7. VERIFY: Run `git log -1` to confirm message

Common Mistakes

Red Flags - STOP

• About to commit with generic message ("update", "fix", "changes")
• Committing multiple unrelated changes together
• Using past tense in description
• Starting description with capital letter
• Message exceeds 72 characters
• No type prefix
• Committing without reviewing staged files

Examples by Scenario

New feature:

git commit -m "feat(search): add fuzzy matching support"

Bug fix with issue reference:

git commit -m "fix(parser): handle empty input correctly" -m "" -m "Fixes #42"

Documentation update:

git commit -m "docs(api): add authentication examples"

Refactoring:

git commit -m "refactor(utils): consolidate date formatting functions"

Breaking change:

git commit -m "feat(config)!: require explicit environment variable" -m "" -m "BREAKING CHANGE: CONFIG_PATH environment variable is now required. Previously defaulted to ./config.json"

Multiple files, single purpose:

git add src/auth.py tests/test_auth.py
git commit -m "feat(auth): implement JWT validation"

Amending Commits

When modifying existing commits:

# Amend message only (last commit)
git commit --amend -m "fix(api): correct type annotation"

# Amend with staged changes (last commit)
git add forgotten_file.py
git commit --amend --no-edit

# Interactive rebase for older commits
git rebase -i HEAD~3
# Change 'pick' to 'reword' for message changes
# Change 'pick' to 'edit' for content changes

The Bottom Line

Every commit tells a story.

Format: type(scope): imperative description

The message should complete: "This commit will [description]"

When in doubt, ask: Would someone understand this commit 6 months from now?

Converted and distributed by TomeVault — claim your Tome and manage your conversions.