From 68b2fefdd1da518ac05e5b69d374c490b44870c5 Mon Sep 17 00:00:00 2001 From: Jakub Florkowski Date: Fri, 21 Nov 2025 00:22:28 +0100 Subject: [PATCH] Updated PR review guidelines and output format Clarified mandatory PR title prefix for agent-generated PRs and expanded the review output format to include a detailed, collapsible markdown structure. Added explicit requirements for file naming, section organization, and review metadata to improve consistency and clarity in PR feedback. --- .../pr-reviewer-agent/core-guidelines.md | 9 +- .../pr-reviewer-agent/output-format.md | 117 ++++++++++++++++-- 2 files changed, 115 insertions(+), 11 deletions(-) diff --git a/.github/instructions/pr-reviewer-agent/core-guidelines.md b/.github/instructions/pr-reviewer-agent/core-guidelines.md index ea7e9369e52f..f0c41a295f6d 100644 --- a/.github/instructions/pr-reviewer-agent/core-guidelines.md +++ b/.github/instructions/pr-reviewer-agent/core-guidelines.md @@ -58,11 +58,14 @@ When multiple instruction files exist, follow this priority order: - **Output**: **ALWAYS** create a markdown file named `Review_Feedback_Issue_XXXXX.md` (replace XXXXX with actual issue number) - **When**: Create this file at the end of EVERY PR review, without exception - **Content**: Include test results, measurements, edge cases tested, and evidence-based recommendations + - **Format**: Use the collapsible format specified in `output-format.md` - **Location**: Save in repository root or as specified by user - **Critical**: This file is the deliverable for every review - do not skip this step -8. πŸ“€ **If submitting changes as a PR**: Use title format `[PR-Reviewer] ` - - This clearly identifies agent-generated PRs containing review feedback and suggested improvements - - Example: `[PR-Reviewer] Fix RTL padding for CollectionView on iOS` +8. πŸ“€ **If submitting changes/fixes as a PR**: + - **MANDATORY Title Format**: `[PR-Reviewer] ` + - **Purpose**: Clearly identifies agent-generated PRs containing review feedback and suggested improvements + - **Example**: `[PR-Reviewer] Fix RTL padding for CollectionView on iOS` + - **Rule**: ALWAYS start PR titles with `[PR-Reviewer]` prefix when creating PRs with fixes or improvements ## 🎯 Critical Success Factors diff --git a/.github/instructions/pr-reviewer-agent/output-format.md b/.github/instructions/pr-reviewer-agent/output-format.md index b49dc5116331..2f7afc83f14c 100644 --- a/.github/instructions/pr-reviewer-agent/output-format.md +++ b/.github/instructions/pr-reviewer-agent/output-format.md @@ -2,28 +2,129 @@ ## Review Output Format -Structure your review in this order: +**CRITICAL**: All reviews MUST be saved to a file named `Review_Feedback_Issue_XXXXX.md` (replace XXXXX with the actual issue number). + +Structure your review in this exact format: ```markdown +# Review Feedback: PR #XXXXX - [PR Title] + +## Recommendation +βœ… **Approve** - Ready to merge +⚠️ **Request Changes** - Issues must be fixed +πŸ’¬ **Comment** - Feedback but not blocking +⏸️ **Paused** - Cannot complete review (conflicts, environment issues, etc.) + +**Required changes** (if any): +1. [First required change] +2. [Second required change] + +**Recommended changes** (if any): +1. [First suggested improvement] +2. [Second suggested improvement] + +--- + +
+πŸ“‹ For full PR Review from agent, expand here + ## Summary [2-3 sentence overview of what the PR does and your assessment] +--- + ## Code Review [Your analysis of the code changes - see core-guidelines.md for details] +--- + +## Test Coverage Review +[Analysis of tests added/modified in the PR] + +### Issues Found in Tests (if any) +[Specific test issues with file locations and line numbers] + +--- + ## Testing [Results from your manual testing with the Sandbox app] -## Issues Found -[Any problems, concerns, or questions - or "None" if everything looks good] +### Manual Testing (if applicable) +[Your testing results] -## Recommendation -βœ… **Approve** - Ready to merge -⚠️ **Request Changes** - Issues must be fixed -πŸ’¬ **Comment** - Feedback but not blocking -⏸️ **Paused** - Cannot complete review (conflicts, environment issues, etc.) +### Recommended Testing Steps (if checkpoint created) +[Commands for others to test] + +--- + +## Security Review +[Security assessment - or "βœ… No security concerns" if none found] + +--- + +## Breaking Changes +[Breaking change analysis - or "βœ… No breaking changes" if none found] + +--- + +## Documentation +[Documentation review - or "βœ… Adequate" if satisfactory] + +--- + +## Issues to Address + +### Must Fix Before Merge +[Critical issues that block approval] + +### Should Fix (Recommended) +[Important improvements that should be made] + +### Optional Improvements +[Nice-to-have suggestions] + +--- + +## Approval Checklist +- [ ] Code solves the stated problem correctly +- [ ] Minimal, focused changes +- [ ] No breaking changes +- [ ] Appropriate test coverage exists +- [ ] No security concerns +- [ ] Follows .NET MAUI conventions +[Add specific items relevant to this PR] + +--- + +## Review Metadata +- **Reviewer**: @copilot (PR Review Agent) +- **Review Date**: [YYYY-MM-DD] +- **PR Number**: #XXXXX +- **Issue Number**: #XXXXX +- **Platforms Tested**: [List or "None"] +- **Test Approach**: [Brief description] + +
``` +### Format Requirements + +1. **Top section (always visible)**: + - Title with PR number and title + - Clear recommendation + - Action items separated into "Required" and "Recommended" + - Keep this section concise - reader should understand next steps immediately + +2. **Collapsible section**: + - Contains all detailed analysis + - Wrapped in `
` tag with descriptive summary + - Organized into clearly separated sections with `---` dividers + - Full review context for those who want deep dive + +3. **File naming**: + - Always `Review_Feedback_Issue_XXXXX.md` where XXXXX is the issue number + - Save in repository root unless user specifies different location + ## Final Review Step: Eliminate Redundancy **CRITICAL FINAL STEP**: Before posting your review, eliminate redundancy using this 6-step self-review process: