Skip to content

Instantly share code, notes, and snippets.

@greatSumini
Created July 9, 2025 17:19
Show Gist options
  • Save greatSumini/6cf4db90b87543c76d1252ec577796c5 to your computer and use it in GitHub Desktop.
Save greatSumini/6cf4db90b87543c76d1252ec577796c5 to your computer and use it in GitHub Desktop.
Git Commit Message Rule
---
description:
globs:
alwaysApply: true
---
# Git Commit Message Rules
## Format Structure
```
<type>(<scope>): <description>
[optional body]
[optional footer]
```
## Types (Required)
- `feat`: new feature
- `fix`: bug fix
- `docs`: documentation only
- `style`: formatting, missing semi colons, etc
- `refactor`: code change that neither fixes bug nor adds feature
- `perf`: performance improvement
- `test`: adding missing tests
- `chore`: updating grunt tasks, dependencies, etc
- `ci`: changes to CI configuration
- `build`: changes affecting build system
- `revert`: reverting previous commit
## Scope (Optional)
- Component, file, or feature area affected
- Use kebab-case: `user-auth`, `payment-api`
- Omit if change affects multiple areas
## Description Rules
- Use imperative mood: "add" not "added" or "adds"
- No capitalization of first letter
- No period at end
- Max 50 characters
- Be specific and actionable
## Body Guidelines
- Wrap at 72 characters
- Explain what and why, not how
- Separate from description with blank line
- Use bullet points for multiple changes
## Footer Format
- `BREAKING CHANGE:` for breaking changes
- `Closes #123` for issue references
- `Co-authored-by: Name <email>`
## Examples
```
feat(auth): add OAuth2 Google login
fix: resolve memory leak in user session cleanup
docs(api): update authentication endpoints
refactor(utils): extract validation helpers to separate module
BREAKING CHANGE: remove deprecated getUserData() method
```
## Workflow Integration
**ALWAYS write a commit message after completing any development task, feature, or bug fix.**
## Validation Checklist
- [ ] Type is from approved list
- [ ] Description under 50 chars
- [ ] Imperative mood used
- [ ] No trailing period
- [ ] Meaningful and clear context
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment