// Create conventional commit messages following best conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits specification.
| name | conventional-commit |
| description | Create conventional commit messages following best conventions. Use when committing code changes, writing commit messages, or formatting git history. Follows conventional commits specification. |
| license | MIT |
| metadata | {"version":"1.0.0"} |
Follow these conventions when creating commits.
Before committing, ensure you're working on a feature branch, not the main branch.
# Check current branch
git branch --show-current
If you're on main, create a new branch first:
# Create and switch to a new branch
git checkout -b <short-description>
Branch naming needs to be short to fit URL length constraints.
<type>(<scope>): <subject>
<body>
<footer>
The header is required. Scope is optional. All lines must stay under 100 characters.
Use the types defined in .ai/config.json under git.types.
| Type | Purpose |
|---|---|
build | Build system or CI changes |
chore | Routine maintenance tasks, dependency updates |
ci | Continuous integration configuration |
docs | Documentation changes |
feat | New feature |
fix | Bug fix |
perf | Performance improvement |
refactor | Code refactoring (no behavior change) |
revert | Revert a previous commit |
style | Code style and formatting |
test | Tests added, updated or improved |
Source list: .ai/config.json → git.types.
subject-case rule forbids sentence-case, start-case, pascal-case, and upper-case)The commit contains the following structural elements, to communicate intent to the consumers of your library:
fix(api): handle null response in user endpoint
- the user API could return null for deleted accounts, causing a crash
in the dashboard
- add a null check before accessing user properties to prevent the
unhandled exception
feat(alerts): add Slack thread replies for alert updates
- post a reply to the original Slack thread when an alert is updated
or resolved instead of creating a new message
- keeps related notifications grouped together for easier scanning
- reduces noise in high-volume alert channels
refactor: extract common validation logic to shared module
Move duplicate validation code from three endpoints into a shared
validator class. No behavior change.
feat(api)!: remove deprecated v1 endpoints
Remove all v1 API endpoints that were deprecated in version 23.1.
Clients should migrate to v2 endpoints.
BREAKING CHANGE: v1 endpoints no longer available
revert: feat(api): add new endpoint
This reverts commit abc123def456.
Reason: Caused performance regression in production.
Scaffold and implement a new EDS block for Spectrum Hub. Use when adding a new block — covers file structure, the init(el) function contract, template injection, CSS conventions, and when to use templates vs per-page authoring vs fragments.
Stylesheet organization, design token usage, light/dark mode, and CSS conventions for Spectrum Hub. Use when adding global styles, creating block CSS, or structuring new stylesheet files.
Implement WCAG 2.2 compliant interfaces with mobile accessibility, inclusive design patterns, and assistive technology support. Use when auditing accessibility, implementing ARIA patterns, building for screen readers, or ensuring inclusive user experiences.