Documentation
README
Git Commit
$ARGUMENTS
Creates well-structured git commits following Conventional Commits specification.
Project context
- Staged changes: !
git diff --cached --stat 2>/dev/null || echo "nothing staged" - Current branch: !
git branch --show-current 2>/dev/null
Commit Format
<type>(<scope>): <description>
[optional body]
[optional footer]
Types
| Type | Description |
|---|---|
feat |
New feature |
fix |
Bug fix |
docs |
Documentation only |
style |
Formatting, no code change |
refactor |
Code restructuring |
perf |
Performance improvement |
test |
Adding/updating tests |
chore |
Maintenance tasks |
ci |
CI/CD changes |
Examples
This is the opening of the README. Read the full README on GitHub.