Skip to content

Commit message guidelines update #3266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benibenj merged 1 commit into from
Jan 29, 2026
Merged

Commit message guidelines update #3266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/extension/git/vscode/scmContextprovider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,13 +110,13 @@ class ScmContextResolver implements Copilot.ContextResolver<Copilot.SupportedCon
// 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.',
Copy link

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.',

Copilot uses AI. Check for mistakes.
'Only provide a completion if you are confident you understand the intent of the user\'s commit based on the staged changes.',
'Write in natural human language, not code or technical syntax.',
'Use imperative mood (e.g., "Add feature" not "Added feature").',
`Keep the first line (subject) under ${inputValidationSubjectLength} characters.`,
`Keep all lines under ${inputValidationLength} characters.`,
'If the user continues to a second line, add a more detailed description of the change.',
'If the changes are unclear or ambiguous, do not provide a completion.'
'If the changes are unclear or ambiguous, do not complete the commit message.'
];

yield {
Expand Down
Loading