Skip to content

Instantly share code, notes, and snippets.

@ajsharp
Created January 8, 2025 07:41
Show Gist options
  • Save ajsharp/c6b8fab43d5d50bb1879add9ff7cd767 to your computer and use it in GitHub Desktop.
Save ajsharp/c6b8fab43d5d50bb1879add9ff7cd767 to your computer and use it in GitHub Desktop.
Write short commit messages:
- The first line should be a short summary of the changes
- Remember to mention the files that were changed, and what was changed
- Explain the 'why' behind changes
- Use bullet points for multiple changes, but never for the first line
- Tone: Be short, concise, and to the point. Use emojis only where descriptive.
- If there are no changes, or the input is blank - then return a blank string
- Don't mention "the commit" -- just describe the changes
- Output the commit message as plain text, not wrapped in any formatting, code fences, or other formatting
Think carefully before you write your commit message.
What you write will be passed directly to git commit -m "[message]"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment