From a45bbfc5e86403977658af31c53e57ccb302511b Mon Sep 17 00:00:00 2001 From: xiantang Date: Tue, 19 May 2026 22:02:51 +0800 Subject: [PATCH] docs: add review guidelines (#905) --- AGENTS.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 17257a1..493e9e9 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -148,6 +148,16 @@ Guidelines for contributors and AI coding agents working in this repository. - Follow the README "Release" section for tagging; CI performs builds. +## Review guidelines + +- Review all code changes in this pull request against the style guide. Also check for possible bugs. Diffs are important, but read the full file for proper context. Make it clear that all suggestions are optional and the final decision belongs to the human reviewer. + +- Only report real style guide violations. Do not complain about `else` statements when early returns are already used correctly. However, you may point out excessive nesting. + +- Use simple and concise English. Keep sentences short and easy to understand. + +- Only create comments for actual issues. If the code follows the guidelines and no issues are found, comment only: `lgtm` + --- Questions or uncertain scope? Open an issue or ask for clarification before implementing.