docs(ai): add reviewer guideline - #1189
Open
zhijie-yang wants to merge 9 commits into
Open
Conversation
zhijie-yang
requested review from
alesancor1 and
lczyk
and
a balanced review from Copilot
and removed request for
alesancor1
August 25, 2026 16:15
Contributor
There was a problem hiding this comment.
Pull request overview
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Adds an AI/human reviewer guide and updates contributor/docs guidance to reflect the repo’s current vulnerability-filtering policy (favoring ignored-vulnerabilities and deprecating .trivyignore).
Changes:
- Added
AGENTS.mdwith a standardized PR review checklist and local AI self-review workflow. - Updated
README.mdto documentignored-vulnerabilitiesand clarify.trivyignoredeprecation/compatibility. - Updated
CONTRIBUTING.mdto recommend an AI-assisted self-review prior to opening PRs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Updates vulnerability-filtering documentation and workflow input descriptions, adds .trivyignore legacy guidance. |
| CONTRIBUTING.md | Adds a pre-PR AI self-review recommendation referencing AGENTS.md. |
| AGENTS.md | Introduces a comprehensive agent/human PR review standard and local review procedure. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Description
AGENTS.mdfile that provides the guideline to help AI agents review this repo, both locally and with Copilot.CONTRIBUTING.mdto instruct the contributor using the AI to pre-review before submitting the PR.README.mdwithAGENTS.mdfor our current policy regarding the vulnerability managements.Related issues
N/A
Picture of a cool rock: