diff --git a/AGENTS.md b/AGENTS.md index 7f33d5b..d2238f3 100644 --- a/AGENTS.md +++ b/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 For issues or questions: