Write a commit message that follows the rules detected in step 2 (or the default), and matches the project's existing style. Commit messages serve as a persistent record for future agents and developers understanding project history — include enough detail that someone reading git log can understand what changed and why without reading the diff.
- Format with ticket:
type(TICKET-ID): Sentence-case description
- Format without ticket:
type: Sentence-case description
- If step 2 detected a different
subject-case (e.g. lower-case, start-case), use that instead.
- After the subject line, add a short paragraph explaining the broader context or motivation when it isn't obvious from the subject alone.
- Add bullet points describing each meaningful unit of work (components, features, routes, behavioral changes) — not raw file paths.
- If a ticket was provided, add a
Ticket: footer at the end of the message body.
Example:
feat(SALES-456): Add Sales Performance dashboard
Add a new dashboard for sales leadership to track revenue,
pipeline health, and rep performance at a glance.
- Add RevenueKPICards showing MTD revenue, deals closed,
average deal size, and quota attainment with period-over-period deltas
- Add PipelineFunnelChart visualizing deal progression across
stages from prospecting through closed-won
- Add RevenueTrendChart with 12-month line chart and
quarterly target overlay
- Add RepLeaderboard ranked by closed revenue with sortable
columns for deals, win rate, and average cycle time
- Add DateRangeFilter and TeamFilter controls wired to
shared dashboard state
- Integrate sales route and nav menu entry
Ticket: SALES-456