📝 docs: add comprehensive commit conventions with gitmoji reference
Added detailed commit conventions section including: - Conventional Commit types (feat, fix, docs, style, refactor, perf, test, chore) - Practical examples for each commit type - Comprehensive gitmoji reference table with 16 common emojis - Emoji codes, types, and descriptions for quick reference - Benefits of using the convention This provides a complete indexed reference so we won't need to check gitmoji.dev repeatedly for common emojis.
This commit is contained in:
66
AGENTS.md
66
AGENTS.md
@@ -715,6 +715,72 @@ type ApiV1Greet interface {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 📝 Commit Conventions
|
||||||
|
|
||||||
|
**Follow Conventional Commits for clear communication:**
|
||||||
|
|
||||||
|
**Core Types:**
|
||||||
|
- `feat`: New user-facing feature
|
||||||
|
- `fix`: Bug fix for users
|
||||||
|
- `docs`: Documentation changes
|
||||||
|
- `style`: Code formatting (no functional change)
|
||||||
|
- `refactor`: Code structure changes
|
||||||
|
- `perf`: Performance improvements
|
||||||
|
- `test`: Test additions/corrections
|
||||||
|
- `chore`: Build process, dependencies, maintenance
|
||||||
|
|
||||||
|
**Examples:**
|
||||||
|
```bash
|
||||||
|
# New feature
|
||||||
|
git commit -m "feat: add user authentication"
|
||||||
|
|
||||||
|
# Bug fix
|
||||||
|
git commit -m "fix: prevent race condition in cache"
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
git commit -m "docs: add API endpoint documentation"
|
||||||
|
|
||||||
|
# Maintenance
|
||||||
|
git commit -m "chore: update dependencies"
|
||||||
|
|
||||||
|
# Refactoring
|
||||||
|
git commit -m "refactor: extract user service from controller"
|
||||||
|
```
|
||||||
|
|
||||||
|
**Optional Emoji Support:**
|
||||||
|
- Use [gitmoji](https://gitmoji.dev) for visual commit messages
|
||||||
|
- Example: `git commit -m "✨ feat: add new API endpoint"`
|
||||||
|
|
||||||
|
**Common Gitmoji Reference:**
|
||||||
|
|
||||||
|
| Emoji | Code | Type | Description |
|
||||||
|
|-------|------|------|-------------|
|
||||||
|
| ✨ | `:sparkles:` | feat | New feature |
|
||||||
|
| 🐛 | `:bug:` | fix | Bug fix |
|
||||||
|
| 📝 | `:memo:` | docs | Documentation |
|
||||||
|
| 🎨 | `:art:` | style | Code formatting |
|
||||||
|
| 🔧 | `:wrench:` | chore | Build/config changes |
|
||||||
|
| ♻️ | `:recycle:` | refactor | Code refactoring |
|
||||||
|
| 🚀 | `:rocket:` | perf | Performance improvements |
|
||||||
|
| 🔒 | `:lock:` | security | Security fixes |
|
||||||
|
| 📦 | `:package:` | dependencies | Dependency changes |
|
||||||
|
| 🔥 | `:fire:` | remove | Remove code/files |
|
||||||
|
| 🐧 | `:penguin:` | linux | Linux-specific changes |
|
||||||
|
| 🍎 | `:apple:` | macos | macOS-specific changes |
|
||||||
|
| 🪟 | `:window:` | windows | Windows-specific changes |
|
||||||
|
| 🤖 | `:robot:` | ci | CI/CD changes |
|
||||||
|
| 🧪 | `:test_tube:` | test | Tests |
|
||||||
|
| 📈 | `:chart_with_upwards_trend:` | analytics | Analytics/SEO |
|
||||||
|
| 🌐 | `:globe_with_meridians:` | i18n | Internationalization |
|
||||||
|
| ⚡ | `:zap:` | performance | Performance improvements |
|
||||||
|
|
||||||
|
**Benefits:**
|
||||||
|
- Clear communication of change types
|
||||||
|
- Better git history readability
|
||||||
|
- Tool compatibility (changelog generators, etc.)
|
||||||
|
- Consistent project history
|
||||||
|
- Visual scanning of commit history
|
||||||
|
|
||||||
## 📞 Support
|
## 📞 Support
|
||||||
|
|
||||||
For issues or questions:
|
For issues or questions:
|
||||||
|
|||||||
Reference in New Issue
Block a user