Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a repository-level set of Copilot code review instructions distilled from recent human review feedback, aiming to reduce review burden and verbosity.
Changes:
- Introduces general PR review rules focused on goal alignment and limiting blast radius.
- Adds documentation-specific review rules for Markdown/MDX and user-facing guides.
Comments suppressed due to low confidence (1)
.github/copilot-instructions.md:30
- The link requirements in lines 25 and 30 overlap and partially duplicate each other, which conflicts with the rule on removing duplication (line 28). Consider merging these into a single bullet that covers both config/API links and package/tool links, to keep the instruction set concise and non-redundant.
- Link each mentioned config option or API to its canonical official documentation.
- Call out global side effects of configuration choices and propose safer scoped alternatives when relevant.
- Avoid misleading examples or outputs; add clarifying context when artifacts may look incorrect.
- Remove duplicated explanations and keep one authoritative location per concept.
- Prefer concise, copy-pasteable command examples when multiple dependencies or setup steps are required.
- Ensure every mentioned package, plugin, or tool has a direct authoritative reference link.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Timeless0911
approved these changes
Mar 3, 2026
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
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.
Summary
i had the agent collect all non-BOT human review comments from the past two months and then summarized rule instructions applicable to future PRs, hoping this will reduce the burden of manual review and make Copilot's review information less verbose.
Related Links
Checklist