| name | commit-and-pr-messages |
| description | Write Git commit messages and pull request titles/descriptions using the Chris Beams / Tim Pope conventions (subject/body split, ~50-char subject, imperative mood, why-not-how body) plus ASD-STE100 Simplified Technical English for bodies and PR descriptions. Use when creating commits, drafting or editing PR descriptions, writing PR titles, or when the user asks for help with commit/PR wording, changelogs from commits, or git history style. |
Commit and PR Messages
Write history that future readers can scan, search, and trust. A diff shows
what changed; the message must explain why.
Based on How to Write a Git Commit Message
(Chris Beams) and A Note About Git Commit Messages
(Tim Pope), adapted for SuperPlane's Conventional Commits + DCO requirements.
Language: Write commit bodies, PR titles (after the type prefix), and PR
descriptions in ASD-STE100 Simplified Technical English style. Follow
simplified-technical-english
before you finalize wording.
When to use
- Creating or amending a commit message
- Opening or updating a pull request (title and body)
- Reviewing whether a PR description is useful to reviewers
Commit messages — seven rules
- Separate subject from body with a blank line.
- Limit the subject line to ~50 characters (72 hard max). Prefer the
Conventional Commits prefix used by this repo (
feat:, fix:, chore:,
docs:) plus a short imperative summary; keep the whole subject readable.
- Capitalize the subject line after the optional type prefix
().
