Commit message guidelines update #3266
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the prompt guidelines used to generate Git commit message completions in the SCM input field.
Changes:
- Adds a guideline emphasizing that commit messages should accurately describe the change succinctly.
- Removes the guideline about adding a detailed second line.
- Rewords the “unclear/ambiguous changes” instruction.
Comments suppressed due to low confidence (1)
src/extension/git/vscode/scmContextprovider.ts:119
- This guideline uses different terminology ("do not complete the commit message") than the rest of the list (e.g., "provide a completion"). For consistency and to avoid confusing the model about the desired behavior, consider keeping the same term ("do not provide a completion").
'If the changes are unclear or ambiguous, do not complete the commit message.'
| // Build commit message guidelines based on configuration | ||
| const guidelines: string[] = [ | ||
| 'This is a git commit message input field.', | ||
| 'The commit message should accurately describe the changes being committed in less than a sentence.', |
There was a problem hiding this comment.
The guideline "in less than a sentence" is unclear/awkward phrasing and may be interpreted inconsistently (e.g., fragment vs. short sentence). Consider rewording to something unambiguous like "in a single short sentence" (or "as a short phrase" if fragments are intended).
Suggested change
| 'The commit message should accurately describe the changes being committed in less than a sentence.', | |
| 'The commit message should accurately describe the changes being committed in a single short sentence.', |
jrieken
approved these changes
Jan 29, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.