Add Code Review Guidelines to copilot-instructions.md #522
Conversation
… passes and avoiding stale comments Co-authored-by: YunchuWang <[email protected]>
There was a problem hiding this comment.
Pull request overview
This PR enhances the GitHub Copilot instructions by adding a dedicated "Code Review Guidelines" section that establishes best practices for code review processes. The guidelines aim to improve review quality by ensuring comprehensive, consolidated feedback and avoiding redundant or stale comments.
Key Changes
- Added new "Code Review Guidelines" section with two important principles for conducting reviews
- Guideline 1: Consolidate all feedback into a single comprehensive review pass
- Guideline 2: Only surface relevant issues and avoid re-posting resolved comments
.github/copilot-instructions.md
Outdated
| When reviewing code, follow these guidelines: | ||
|
|
||
| - Provide all review comments in a single review pass. Avoid scattering feedback across multiple partial reviews; consolidate findings into one coherent review round. | ||
| - Do not generate false-positive or already-resolved comments when new commits are pushed. Only surface issues that still apply after the latest changes, and avoid re-posting comments that have been addressed or are no longer relevant. |
There was a problem hiding this comment.
Can we be more specific with addressed? I think we should break it into another bullet point and say something along the lines of "Do not post a review comment that has been directly responded to by a user with justification for why it exists." Or something along those lines, I'm sure copilot can figure out how to write that better :)
There was a problem hiding this comment.
@copilot update this pr to address the comment above
There was a problem hiding this comment.
Added a new bullet point that specifically addresses this: "Do not re-post a review comment if a user has directly responded to it with justification for why the code exists as written. Respect user explanations and avoid redundant feedback on justified code decisions." (21ccb86)
|
@copilot update this pr to address the comment |
Co-authored-by: YunchuWang <[email protected]>
This was already addressed in commit 21ccb86. Line 76 now includes: "Do not re-post a review comment if a user has directly responded to it with justification for why the code exists as written. Respect user explanations and avoid redundant feedback on justified code decisions." |
Adds review behavior guidelines to ensure consistent, high-quality code reviews.
Changes
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.