--- name: Conventional Commits description: Conventional Commits specification format. Use when creating commit messages. Format: (): . Types: feat, fix, chore, docs, test, refactor, style, perf. CRITICAL: All commits must follow conventional commit format. allowed-tools: Read, Write, Edit, Bash, Grep, Glob --- # Conventional Commits Skill **CRITICAL**: All commits must follow Conventional Commits format: `(): ` ## When to Use This Skill Use this skill when: - Creating commit messages - Formatting commits - Understanding commit types - Writing commit descriptions ## Commit Format ``` (): [optional body] [optional footer] ``` ## Commit Types | Type | Purpose | Example | |------|---------|---------| | `feat` | New feature | `feat(auth): add user login` | | `fix` | Bug fix | `fix(api): resolve memory leak` | | `chore` | Maintenance tasks | `chore(deps): update packages` | | `docs` | Documentation changes | `docs(readme): update install guide` | | `test` | Test additions/changes | `test(auth): add unit tests` | | `refactor` | Code refactoring | `refactor(api): restructure services` | | `style` | Code style changes | `style: format code with prettier` | | `perf` | Performance improvements | `perf(api): optimize database query` | | `ci` | CI/CD changes | `ci: add GitHub Actions workflow` | | `build` | Build system changes | `build: update webpack config` | ## Scope Guidelines Scopes identify the affected area: ### API Scopes ```bash feat(api): add new endpoint fix(api): resolve endpoint error refactor(api): restructure controllers ``` ### Module Scopes ```bash feat(auth): add authentication fix(llm): resolve provider issue chore(mcp): update MCP tools ``` ### Feature Scopes ```bash feat(agents): add new agent type fix(webhooks): resolve status tracking perf(orchestration): optimize execution ``` ## Commit Examples ### Simple Commit ```bash feat(auth): add JWT token authentication ``` ### Commit with Body ```bash feat(auth): add JWT token authentication Implement JWT token generation and validation. - Add token generation service - Add token validation middleware - Update auth controller ``` ### Commit with Footer ```bash fix(api): resolve memory leak The service was holding references to completed requests. Now properly cleans up after request completion. Closes #123 ``` ### Breaking Change ```bash feat(api)!: change authentication endpoint BREAKING CHANGE: Authentication endpoint moved from /auth/login to /api/auth/login ``` ## Common Patterns ### Feature Development ```bash feat(user-dashboard): add user dashboard component - Create dashboard Vue component - Add user stats API endpoint - Implement real-time updates ``` ### Bug Fixes ```bash fix(login): resolve authentication error The login was failing due to incorrect token validation. Fixed by updating token validation logic. Fixes #456 ``` ### Chores ```bash chore(deps): update NestJS to v10 - Update @nestjs/core to 10.0.0 - Update @nestjs/common to 10.0.0 - Resolve breaking changes ``` ### Documentation ```bash docs(api): update API documentation - Add endpoint documentation - Update examples - Fix formatting issues ``` ### Tests ```bash test(auth): add unit tests for auth service - Test login functionality - Test token generation - Test error handling ``` ### Refactoring ```bash refactor(api): restructure service layer - Extract common service logic - Improve dependency injection - Update module structure ``` ## ❌ Bad Commit Messages ```bash ❌ fix stuff ❌ update ❌ changes ❌ WIP ❌ asdf ❌ fixed bug ❌ add feature ❌ work in progress ❌ commit ❌ test ``` ## ✅ Good Commit Messages ```bash ✅ feat(auth): add user authentication ✅ fix(api): resolve memory leak in service ✅ chore(deps): update dependencies ✅ docs(readme): update installation guide ✅ test(auth): add unit tests for login ✅ refactor(api): restructure service layer ✅ perf(db): optimize query performance ✅ style: format code with prettier ``` ## Multi-Line Commit Messages ### Format ```bash ():