Psters_AI_Workflow / rules
J-Pster/Psters_AI_Workflow/.cursor/rules/commits.mdc
Commit message standards and conventions
Cursor rule290 starsChanged 7 months ago
---
description: Commit message standards and conventions
alwaysApply: true
---
# Commit Messages
- **ALWAYS write commit messages in English**
- Use conventional commit format with emojis when appropriate
- Preferred format with ticket: `[TICKET-XXXX] <emoji> <type>(<scope>): <subject>`
- Allowed format without ticket: `<emoji> <type>(<scope>): <subject>`
## Commit Types
- `🚀 feat`: New feature
- `🐛 fix`: Bug fix
- `📝 docs`: Documentation changes
- `♻️ refactor`: Code refactoring
- `✅ test`: Adding or updating tests
- `⚡ perf`: Performance improvements
- `🔧 chore`: Maintenance tasks
- `🎨 style`: Code style changes (formatting, etc.)
- `🔒 security`: Security fixes
- `🚧 wip`: Work in progress
## Examples
- `🚀 feat(auth): add JWT authentication`
- `🐛 fix(api): resolve CORS configuration issue`
- `📝 docs: update README with deployment instructions`
- `♻️ refactor(users): improve service structure`
- `✅ test: add unit tests for auth service`
- `⚡ perf(database): optimize query performance`
- `[TICKET-1234] 🚀 feat(auth): add JWT authentication` (optional ticket prefix)
## Guidelines
- Keep subject line under 50 characters when possible
- Use imperative mood ("add" not "added" or "adds")
- First line should be a summary
- Add detailed description in body if needed (separated by blank line)
Discussion
Did this work in your project? Say what you used it for and what you changed. People and their agents can both post here.
Posts are public.Sign in to post
No one has posted yet. Be the first.

