Inkblot commit messages
This convention is only required when the work has a Jira ticket. If there is no ticket, do not invent an ID, do not ask for a ticket, and do not restrict the subject.
Ticket work (required)
<TICKET-ID>: <Concise imperative summary>
- Full Jira key, uppercase, one ticket per commit (e.g.
POD2-2291, not pod2-2291 and not 2-2291)
- Colon and space after the key, then an imperative summary (“Fix …”, “Add …”, “Rename …”)
- Sentence case. One line. Aim for ~72 characters. Say the outcome, not a file list.
- Put the ticket this commit belongs to in the subject — not every ticket on the PR, and not always the branch name.
Do not use Conventional Commits prefixes (feat:, fix:, chore:). The ticket is the classifier.
Multiple tickets on one piece of work
A branch/PR may list several tickets. Each commit still has one key: the ticket that commit implements or fixes.
- Default to the branch ticket (
pod2-2291-… → POD2-2291: …) when the commit is for that work.
- If this commit is for a different linked ticket, switch the subject to that key.
- If it is unclear which ticket this commit belongs to, ask. Do not invent an ID and do not stack keys (
POD2-2276-2277: …).
Example — branch pod2-2276-restrict-provider-access, also linked to POD2-2277:
POD2-2276: Restrict availability reserved-for-clientPOD2-2277: Hide estimates from unauthorized clients
Examples
POD2-2291: Fix no-show video call outcomePOD2-2291: Baseline the false-positive Brakeman role warningPOD1-3452: Rename renewal date service to resolverPOD1-3452: Guard missing specialized renewal periods
Body
No rule. Do not require a body and do not add one unless the user asks. Context lives in Jira.
Do not (ticket work only)
feat: add renewal dates / fix: … — no Conventional Commitspod2-2291: Fix no-show … — uppercase the key in commits2-2291: Fix no-show … — not a Jira keyPOD2-2291 - fix stuff — use : , not -POD2-2291: Fixed bug — prefer imperative (Fix …)POD2-2276-2277: … — one primary ticket in the subject- Inventing a ticket ID
Validation (for hooks / lint)
^[A-Z][A-Z0-9]+-[0-9]+: .+
No ticket
No subject rule. Merge commits, syncs, and other untracked work can use any subject.
Why
- Ticket in the subject: Jira Smart Commits and GitHub–Jira linking read the commit subject. The branch name is not enough.
- Uppercase here, lowercase on branches: Trackers expect the canonical
POD2-2291: form. Branches stay lowercase to avoid git case-sensitivity.
- No
feat: / fix:: The ticket already classifies the work. Two prefixes only make the subject longer.
- Rule only when a ticket exists: Same as branches. Do not block chores, merges, or hotfixes that have no ticket.
- One ticket per commit, not per branch: Jira attaches the commit to the key in the subject. If one PR covers several tickets, each commit should land on the ticket it actually changes. Stacking IDs in the subject breaks grep, hooks, and that attachment.
- No body convention: The ticket already has context. A second paragraph in git does not help Jira linking and is easy for agents to invent.
1---2name: inkblot-commit-message3description: Inkblot git commit message convention. Use when writing a commit message, creating a git commit, amending a commit message, or when the user asks how to format a commit subject.4---56# Inkblot commit messages78This convention is **only required when the work has a Jira ticket**. If there is no ticket, do not invent an ID, do not ask for a ticket, and do not restrict the subject.910## Ticket work (required)1112```text13<TICKET-ID>: <Concise imperative summary>14```15161. Full Jira key, **uppercase**, **one** ticket per commit (e.g. `POD2-2291`, not `pod2-2291` and not `2-2291`)172. Colon and space after the key, then an imperative summary (“Fix …”, “Add …”, “Rename …”)183. Sentence case. One line. Aim for ~72 characters. Say the outcome, not a file list.194. Put the ticket **this commit** belongs to in the subject — not every ticket on the PR, and not always the branch name.2021Do **not** use Conventional Commits prefixes (`feat:`, `fix:`, `chore:`). The ticket is the classifier.2223### Multiple tickets on one piece of work2425A branch/PR may list several tickets. Each commit still has **one** key: the ticket that commit implements or fixes.2627- Default to the branch ticket (`pod2-2291-…` → `POD2-2291: …`) when the commit is for that work.28- If this commit is for a different linked ticket, switch the subject to that key.29- If it is unclear which ticket this commit belongs to, ask. Do not invent an ID and do not stack keys (`POD2-2276-2277: …`).3031Example — branch `pod2-2276-restrict-provider-access`, also linked to `POD2-2277`:3233- `POD2-2276: Restrict availability reserved-for-client`34- `POD2-2277: Hide estimates from unauthorized clients`3536### Examples3738- `POD2-2291: Fix no-show video call outcome`39- `POD2-2291: Baseline the false-positive Brakeman role warning`40- `POD1-3452: Rename renewal date service to resolver`41- `POD1-3452: Guard missing specialized renewal periods`4243### Body4445No rule. Do not require a body and do not add one unless the user asks. Context lives in Jira.4647### Do not (ticket work only)4849- `feat: add renewal dates` / `fix: …` — no Conventional Commits50- `pod2-2291: Fix no-show …` — uppercase the key in commits51- `2-2291: Fix no-show …` — not a Jira key52- `POD2-2291 - fix stuff` — use `: `, not ` - `53- `POD2-2291: Fixed bug` — prefer imperative (`Fix …`)54- `POD2-2276-2277: …` — one primary ticket in the subject55- Inventing a ticket ID5657### Validation (for hooks / lint)5859```text60^[A-Z][A-Z0-9]+-[0-9]+: .+61```6263## No ticket6465No subject rule. Merge commits, syncs, and other untracked work can use any subject.6667## Why6869- **Ticket in the subject:** Jira Smart Commits and GitHub–Jira linking read the commit subject. The branch name is not enough.70- **Uppercase here, lowercase on branches:** Trackers expect the canonical `POD2-2291:` form. Branches stay lowercase to avoid git case-sensitivity.71- **No `feat:` / `fix:`:** The ticket already classifies the work. Two prefixes only make the subject longer.72- **Rule only when a ticket exists:** Same as branches. Do not block chores, merges, or hotfixes that have no ticket.73- **One ticket per commit, not per branch:** Jira attaches the commit to the key in the subject. If one PR covers several tickets, each commit should land on the ticket it actually changes. Stacking IDs in the subject breaks grep, hooks, and that attachment.74- **No body convention:** The ticket already has context. A second paragraph in git does not help Jira linking and is easy for agents to invent.
inkblot-therapy