diff --git a/README.md b/README.md index 909bbf1..bffb924 100644 --- a/README.md +++ b/README.md @@ -346,6 +346,17 @@ For complete agent usage guide including: See: [AGENT_USAGE_GUIDE.md](documentation/AGENT_USAGE_GUIDE.md) +### Gitmoji Cheatsheet + +Quick reference for commit messages: +- **๐Ÿ“ `:memo:` docs** - Documentation +- **โœจ `:sparkles:` feat** - New feature +- **๐Ÿ› `:bug:` fix** - Bug fix +- **โ™ป๏ธ `:recycle:` refactor** - Code refactoring +- **๐Ÿ”ง `:wrench:` chore** - Build/config changes + +Full cheatsheet: [GITMOJI_CHEATSHEET.md](documentation/GITMOJI_CHEATSHEET.md) + ## License MIT diff --git a/documentation/GITMOJI_CHEATSHEET.md b/documentation/GITMOJI_CHEATSHEET.md new file mode 100644 index 0000000..e6e9f81 --- /dev/null +++ b/documentation/GITMOJI_CHEATSHEET.md @@ -0,0 +1,136 @@ +# Gitmoji Cheatsheet + +## ๐ŸŽฏ Purpose + +Quick reference for using Gitmoji in commit messages. Follows the [Common Gitmoji Reference](https://gitmoji.dev/) standard as documented in [AGENTS.md](../AGENTS.md). + +## ๐Ÿ“‹ When to Use Gitmoji + +**Always use Gitmoji** for: +- Feature commits (`โœจ feat:`) +- Bug fixes (`๐Ÿ› fix:`) +- Documentation (`๐Ÿ“ docs:`) +- Refactoring (`โ™ป๏ธ refactor:`) +- Build/config changes (`๐Ÿ”ง chore:`) + +**Format:** `๐Ÿ“ docs: brief description of changes` + +## ๐Ÿ”‘ Common Gitmoji + +### Feature & Bug Changes +``` +โœจ `:sparkles:` - New feature +๐Ÿ› `:bug:` - Bug fix +โ™ป๏ธ `:recycle:` - Code refactoring +๐Ÿ”ฅ `:fire:` - Remove code/files +๐Ÿš€ `:rocket:` - Performance improvements +๐Ÿ”’ `:lock:` - Security fixes +``` + +### Documentation & Style +``` +๐Ÿ“ `:memo:` - Documentation changes +๐ŸŽจ `:art:` - Code formatting/style +๐Ÿ“ฆ `:package:` - Dependency changes +``` + +### Testing & CI/CD +``` +๐Ÿงช `:test_tube:` - Tests +๐Ÿค– `:robot:` - CI/CD changes +``` + +### Platform-Specific +``` +๐Ÿง `:penguin:` - Linux changes +๐ŸŽ `:apple:` - macOS changes +๐ŸชŸ `:window:` - Windows changes +``` + +### Other Common +``` +๐Ÿ“ˆ `:chart_with_upwards_trend:` - Analytics/SEO +๐ŸŒ `:globe_with_meridians:` - Internationalization +โšก `:zap:` - Performance improvements +๐Ÿ”Œ `:electric_plug:` - Add/remove dependencies +๐Ÿ—๏ธ `:building_construction:` - Architecture changes +``` + +## ๐Ÿ“– Examples + +### Good Commit Messages +``` +โœ… ๐Ÿ“ docs: add AGENT_USAGE_GUIDE.md with launch commands +โœ… โœจ feat: implement OAuth authentication with JWT +โœ… ๐Ÿ› fix: resolve CI workflow validation error +โœ… โ™ป๏ธ refactor: extract payment service from monolith +โœ… ๐Ÿงช test: add BDD scenarios for authentication +โœ… ๐Ÿ”ง chore: update go.mod dependencies +``` + +### Bad Commit Messages +``` +โŒ No gitmoji: "add documentation" +โŒ Wrong gitmoji: "๐Ÿ“– docs: add guide" (should be ๐Ÿ“) +โŒ Too vague: "๐Ÿ“ docs: update" +โŒ Too long: "๐Ÿ“ docs: add comprehensive guide with examples and references and usage patterns" +``` + +## ๐ŸŽฏ Best Practices + +### 1. **Be Specific** +``` +โŒ "๐Ÿ“ docs: update README" +โœ… "๐Ÿ“ docs: add agent launch commands to README" +``` + +### 2. **Use Imperative Mood** +``` +โŒ "๐Ÿ“ docs: added guide" +โœ… "๐Ÿ“ docs: add guide" +``` + +### 3. **Keep It Short** +``` +โŒ "๐Ÿ“ docs: add comprehensive documentation guide with examples and references" +โœ… "๐Ÿ“ docs: add AGENT_USAGE_GUIDE.md" +``` + +### 4. **Link to References** +``` +โœ… "โœจ feat: implement payment system (#42)" +โœ… "๐Ÿ› fix: CI workflow error (see #45)" +โœ… "๐Ÿ“ docs: update README (ref adr/0008)" +``` + +## ๐Ÿ” How to Check Gitmoji + +### Using the commit-message skill +```bash +# Validate a commit message +skill commit-message validate \ + --message "๐Ÿ“ docs: update changelog guide" \ + --file .git/COMMIT_EDITMSG + +# Get suggestions +skill commit-message suggest \ + --type "documentation" \ + --description "update changelog guide" +``` + +### Quick Reference +```bash +# List all gitmoji +skill commit-message list-gitmoji + +# Check specific type +skill commit-message suggest --type "docs" +``` + +## ๐Ÿ“š Reference + +- [Common Gitmoji Reference](https://gitmoji.dev/) +- [AGENTS.md](../AGENTS.md) - Project-specific conventions +- [Conventional Commits](https://www.conventionalcommits.org/) + +**Tip:** Bookmark this cheatsheet or use `skill commit-message list-gitmoji` for quick reference! \ No newline at end of file