| name | conventional-commit |
| description | Generate conventional commit messages for ProjectX by analyzing staged git changes. Supports feat/fix/refactor/test/chore scopes with optional breaking change markers. |
Conventional Commit — ProjectX Apple Platforms
Workflow
- Run
git diff --cached --stat to see staged files
- Run
git diff --cached for actual changes
- Classify the change type
- Generate commit message
Format
<type>(<scope>): <subject>
<body>
<footer>
Types
| Type | When |
|---|
feat | New feature (entity, view, service, route) |
fix | Bug fix |
refactor | Code restructuring without behavior change |
test | Adding or modifying tests |
chore | Build config, tooling, dependencies |
style | DS component updates, formatting |
docs | Documentation changes |
Scopes (from project layers)
| Scope | Maps To |
|---|
domain | Entities, UseCases, Repository protocols |
data | Network, Storage, Repository implementations |
ui | Views, ViewModels, Route, DS components |
ds | Design System components/styles |
shared | Extensions, Utilities, DI, Localization |
config | Build settings, Info.plist |
test | Unit/UI tests |
Examples
feat(domain): add User entity and UserRepositoryProtocol
feat(data): implement UserService with CRUD endpoints
feat(ui): add UserListView with ViewModel and route
fix(data): handle 404 error in DeviceInfoService
refactor(ui): extract common list item into DS component
test(domain): add UserUseCase tests with fake repository
chore(config): update deployment targets to platform 26 SDKs
Breaking Changes
feat(domain)!: rename DeviceInfo to Device
BREAKING CHANGE: DeviceInfo renamed to Device across all layers.
Affects: DeviceInfoService, DeviceInfoRequest, DemoRequestViewModel.
