Skip to content

Add Code Review Guidelines to copilot-instructions.md #522

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
YunchuWang merged 3 commits into from
Dec 3, 2025
Merged

Add Code Review Guidelines to copilot-instructions.md #522

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f232a2
Initial plan
Copilot Dec 3, 2025
3b89b04
Add Code Review Guidelines section with rules for consolidated review…
Copilot Dec 3, 2025
21ccb86
Add guideline for respecting user justifications in review comments
Copilot Dec 3, 2025
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
9 changes: 8 additions & 1 deletion .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,11 @@ Unit tests should follow these guidelines:
- Use the Moq library for mocking objects where possible.
- Validate that each test actually tests the target behavior, e.g. we should not have tests that create a mock, call the mock and then verify that the mock was called, without the target code being involved. We also shouldn't have tests that test language features, e.g. something that the compiler would catch anyway.
- Avoid adding excessive comments to tests. Instead favor clear easy to understand code.
- Follow the patterns in the unit tests in the same project or classes to which new tests are being added.
- Follow the patterns in the unit tests in the same project or classes to which new tests are being added.

## Code Review Guidelines

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.

@halspang halspang Dec 3, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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 :)

@YunchuWang YunchuWang Dec 3, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot update this pr to address the comment above

Copilot AI Dec 3, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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)

Loading