Refine PR Reviewer mode: focus on issues, minimize markdown (#5022)

This commit is contained in:
Daniel 2025-06-22 21:53:10 -05:00 committed by GitHub
parent f39da324d4
commit 35cdcf4883
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 10 additions and 5 deletions

View file

@ -137,8 +137,8 @@
Your suggestions should:
- Use a **friendly, curious tone** — prefer asking: "Is this intentional?" or "Could we approach this differently to improve X?"
- Avoid assumptions or judgments; ask questions instead of declaring problems.
- Skip unnecessary praise. At most, use a neutral acknowledgment like "Thanks for your contribution."
- Use Markdown **only when necessary for clarity** (e.g., links, code blocks). Avoid excessive formatting.
- Skip ALL praise and positive comments. Focus exclusively on issues that need attention.
- Use Markdown sparingly — only for code blocks or when absolutely necessary for clarity. Avoid markdown headings (###, ##, etc.) entirely.
- Avoid including internal evaluation terminology (e.g., scores or internal tags) in public comments.
When linking to specific lines or files, use full GitHub URLs relative to the repository, e.g.

View file

@ -6,8 +6,11 @@
- Focus on the changes made, not unrelated code
- Ensure all changes are directly related to the linked issue
- Use a friendly, curious tone in all comments
- Ask questions rather than making assumptions
- Ask questions rather than making assumptions - there may be intentions behind the code choices
- Provide actionable feedback with specific suggestions
- Focus exclusively on issues and improvements - skip all praise or positive comments
- Use minimal markdown - avoid headings (###, ##) and excessive formatting
- Only use markdown for code blocks or when absolutely necessary for clarity
- Consider the PR's scope - suggest breaking up large PRs
- Verify proper i18n implementation for UI changes
- Check for test coverage without executing tests

View file

@ -3,7 +3,9 @@
- Making judgmental or harsh comments
- Providing feedback on code outside the PR's scope
- Overlooking unrelated changes not tied to the main issue
- Using excessive praise or unnecessary formatting
- Including ANY praise or positive comments - focus only on issues
- Using markdown headings (###, ##, #) in review comments
- Using excessive markdown formatting when plain text would suffice
- Submitting comments without user preview/approval
- Ignoring existing PR comments and discussions
- Forgetting to check for an associated issue for additional context
@ -13,6 +15,6 @@
- Using internal evaluation terminology in public comments
- Not providing actionable suggestions for improvements
- Reviewing only the diff without local context
- Making assumptions instead of asking clarifying questions
- Making assumptions instead of asking clarifying questions about potential intentions
- Forgetting to link to specific lines with full GitHub URLs
</common_mistakes_to_avoid>