git-commit

Original🇺🇸 English
Translated

Creates git commits following Conventional Commits format with type/scope/subject. Use when user wants to commit changes, create commit, save work, or stage and commit. Handles regular branch commits (development) and merge commits (PR closure). Enforces project-specific conventions from CLAUDE.md.

2installs
Added on

NPX Install

npx skill4agent add fvadicamo/dev-agent-skills git-commit

Tags

Translated version includes tags in frontmatter

Git Commit

Creates git commits following Conventional Commits format with proper type, scope, and subject.

Quick Start

bash
# 1. Check for project-specific commit conventions
cat .claude/CLAUDE.md 2>/dev/null | grep -A 20 -i "commit"

# 2. Stage changes
git add <files>  # or: git add -A

# 3. Create commit (branch commit format)
git commit -m "type(scope): subject

Body explaining HOW and WHY.
Reference: Task X.Y, Req N"

Commit Types

Regular Branch Commits (During Development)

Format:
type(scope): subject
TypePurpose
feat
New feature or functionality
fix
Bug fix or issue resolution
refactor
Code refactoring without behavior change
perf
Performance improvements
test
Test additions or modifications
ci
CI/CD configuration changes
docs
Documentation updates
chore
Maintenance, dependencies, tooling
style
Code formatting, linting (non-functional)
security
Security vulnerability fixes or hardening

Scope (Required, kebab-case)

Examples:
validation
,
auth
,
cookie-service
,
template
,
config
,
tests
,
api

Subject Line Rules

  • Max 50 characters after colon
  • Present tense imperative: add, implement, fix, improve, enhance, refactor, remove, prevent
  • NO period at the end
  • Specific and descriptive - state WHAT, not WHY

Core Workflow

1. Check Project Conventions

ALWAYS check first - project may override defaults:
bash
cat .claude/CLAUDE.md 2>/dev/null | grep -A 30 -i "commit"
cat .kiro/steering/*.md 2>/dev/null | grep -A 20 -i "commit"
If project specifies different format, USE PROJECT FORMAT.

2. Review Changes

bash
git status
git diff --staged  # if already staged
git diff           # if not staged

3. Stage Files

bash
git add <specific-files>  # preferred
# or
git add -A  # all changes
NEVER commit:
  • .env
    ,
    credentials.json
    , secrets
  • node_modules/
    ,
    __pycache__/
    ,
    .venv/
  • Large binary files without explicit approval

4. Create Commit

Simple change:
bash
git commit -m "fix(auth): use hmac.compare_digest for secure comparison"
Complex change (with body):
bash
git commit -m "$(cat <<'EOF'
feat(validation): add URLValidator with domain whitelist

Implement URLValidator class supporting:
- Domain whitelist enforcement (youtube.com, youtu.be)
- Dangerous scheme blocking (javascript, data, file)
- URL parsing with embedded credentials handling

Addresses Requirement 31: Input validation
Part of Task 5.1: Input Validation Utilities
EOF
)"

5. Verify Commit

bash
git log -1 --format="%h %s"
git show --stat HEAD

Body Format (Recommended for Complex Changes)

<blank line>
Explain HOW and WHY the change was made.
- Use bullet points for multiple items
- Wrap at 72 characters

Reference: Task X.Y
Addresses: Req N

Git Trailers

TrailerPurpose
Fixes #N
Links and closes issue on merge
Closes #N
Same as Fixes
Co-authored-by: Name <email>
Credit co-contributors
Place trailers at end of body after blank line. See
references/commit_examples.md
for examples.

Breaking Changes

For incompatible API/behavior changes, use
!
after scope OR
BREAKING CHANGE:
footer:
feat(api)!: change response format to JSON:API

BREAKING CHANGE: Response envelope changed from `{ data }` to `{ data: { type, id, attributes } }`.
Triggers major version bump in semantic-release.

Merge Commits (PR Closure)

For PRs, use extended description with sections:
bash
gh pr create --title "feat(security): implement input validation (Task 5)" --body "$(cat <<'EOF'
## Summary
- Input validation utilities (URLValidator, FormatValidator)
- Secure template processor with path traversal prevention
- API key authentication middleware

## Task Breakdown
Task 5.1: Input Validation - URLValidator, FormatValidator
Task 5.2: Template Processing - Path traversal prevention
Task 5.3: API Key Auth - Multi-key support, excluded paths
Task 5.4: Security Tests - 102 path traversal tests

## Requirements Covered
Req 7, Req 9, Req 31, Req 33

## Test Coverage
- All 473 tests passing
- Coverage: 93%
- Pre-commit checks: passing
EOF
)"

Integration with Other Skills

From github-pr-review

When fixing review comments, use this format:
bash
git commit -m "fix(scope): address review comment #ID

Brief explanation of what was wrong and how it's fixed.
Addresses review comment #123456789."

From github-pr-creation

Before creating PR, ensure all commits follow this format. The PR skill will:
  1. Analyze commits for proper format
  2. Extract types for PR labels
  3. Build PR description from commit bodies

Important Rules

  • ALWAYS check project conventions (CLAUDE.md) before committing
  • ALWAYS use project format if it differs from default
  • ALWAYS include scope in parentheses
  • ALWAYS use present tense imperative verb
  • NEVER end subject with period
  • NEVER commit secrets or credentials
  • NEVER use generic messages ("update code", "fix bug", "changes")
  • NEVER exceed 50 chars in subject line
  • Group related changes -> single focused commit

Examples

Good:
feat(validation): add URLValidator with domain whitelist
fix(auth): use hmac.compare_digest for secure key comparison
refactor(template): consolidate filename sanitization logic
test(security): add 102 path traversal prevention tests
Bad:
update validation code           # no type, no scope, vague
feat: add stuff                  # missing scope, too vague
fix(auth): fix bug               # circular, not specific
chore: make changes              # missing scope, vague
feat(security): improve things.  # has period, vague

References

  • references/commit_examples.md
    - Extended examples by type