---

name: conventional-commits description: Guide for writing conventional commits with gitmoji license: MIT OR Apache-2.0

Conventional Commits

Use conventional commit format with gitmoji for all commits in this project.

Format

Copy<type>: <emoji> <description>

Commit Types and Emojis

Additional Emojis

Examples

Copygit commit -m "feat: :sparkles: add user authentication"
git commit -m "fix: :bug: resolve login redirect loop"
git commit -m "docs: :memo: update API documentation"
git commit -m "refactor: :recycle: extract validation logic"
git commit -m "chore: :arrow_up: release v1.0.0"
git commit -m "ci: :construction_worker: add GitHub Actions workflow"

Breaking Changes

For breaking changes, add ! after the type:

Copygit commit -m "feat!: :boom: redesign authentication API"

Scope (Optional)

Add scope in parentheses for more context:

Copygit commit -m "feat(auth): :sparkles: add OAuth2 support"
git commit -m "fix(api): :bug: handle null response"