Generating a git commit message
Instructions
- Run
git status --short,git diff, andgit diff --stagedto gather current changes, including untracked files - If there are staged files, generate commit message suggestions using only staged changes (including staged newly added files)
- If there are no staged files, include unstaged diff changes and untracked files in the suggestion context
- For untracked files, inspect file names and content (for example with
git status --shortandcat/sed) so they are represented in the suggested message - For more context, get the last 5 to 10 commit messages as well
- Suggest a commit message:
- The commit message should be a single line - The commit message should be a summary of the changes - The commit message should follow conventional commit conventions - If there too many changes, suggest multiple commit messages with a split of files between each commit message
Best practices
- Use present tense
- After the tag (e.g.
feat:), the first letter should be capitalized, unless it's a symbol like a function name