-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Updates commit message instructions in auto-compose #4888
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.
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
base: main
Are you sure you want to change the base?
Conversation
Updates the commit message section of the auto-compose prompt to more closely match the existing commit message instructions in generate-commitMessage
🤖 Augment PR SummarySummary: This PR refines the Commit Composer auto-compose prompt so its commit-message guidance aligns more closely with the existing “generate commit message” action. Changes:
Technical Notes: The composed prompt still outputs a single commit message string, while keeping the per-commit 🤖 Was this summary useful? React with 👍 or 👎 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Review completed. No suggestions at this time.
Comment augment review to trigger a new review at any time.
|
Note that the user can provide custom instructions for commit messages in three places now:
Updated the instructions to prioritize them in order from lowest to highest in this order. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates the commit message generation instructions in the auto-compose feature to align more closely with the existing detailed instructions from the generate commit message action. The changes enhance the AI's ability to produce high-quality commit messages by providing more comprehensive guidance on structure, tone, and content.
Changes:
- Expands commit message generation guidelines in the prompts with detailed steps covering analysis, composition rules, formatting, and issue references
- Integrates commit message custom instructions into the generateCommits action with proper priority handling
- Adds telemetry tracking for commit message custom instructions usage and length
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/plus/ai/prompts.ts | Expands commit message generation guidelines with detailed multi-step instructions replacing the previous brief guideline |
| src/plus/ai/actions/generateCommits.ts | Refactors custom instructions handling to incorporate commit message settings with priority ordering |
| src/webviews/plus/composer/composerWebview.ts | Adds telemetry event data fields for tracking commit message custom instructions |
| src/constants.telemetry.ts | Defines new telemetry event properties for commit message custom instructions |
| docs/telemetry-events.md | Documents the new telemetry fields across multiple event types |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The commit message section of the auto-compose prompt now more closely matches the existing detailed instructions we had in the generate commit message action.
Note that this cannot be an exact copy-paste/injection of the
generate-commitMessageprompt itself into thegenerate-commitsprompt because there are some subtle differences:Closes #4870