Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .github/instructions/pr-reviewer-agent/core-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -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] <Original PR Title>`
- 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] <Original PR Title>`
- **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

Expand Down
117 changes: 109 additions & 8 deletions .github/instructions/pr-reviewer-agent/output-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.)
Comment on lines +12 to +16
Copy link

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor inconsistency in section header formatting. In the example provided in the PR description, the recommendation in the visible section uses bold text without a section header (**Recommendation**: βœ… Approve), but the template at line 12 shows it as a proper markdown section header (## Recommendation).

Consider updating line 10-16 to show the expected output format more clearly:

# Review Feedback: PR #XXXXX - [PR Title]

**Recommendation**: [Choose one: βœ… Approve / ⚠️ Request Changes / πŸ’¬ Comment / ⏸️ Paused]

**Required changes** (if any):

This would match the example in the PR description and be more explicit about the expected format.

Suggested change
## Recommendation
βœ… **Approve** - Ready to merge
⚠️ **Request Changes** - Issues must be fixed
πŸ’¬ **Comment** - Feedback but not blocking
⏸️ **Paused** - Cannot complete review (conflicts, environment issues, etc.)
**Recommendation**: [Choose one: βœ… Approve / ⚠️ Request Changes / πŸ’¬ Comment / ⏸️ Paused]

Copilot uses AI. Check for mistakes.

**Required changes** (if any):
1. [First required change]
2. [Second required change]

**Recommended changes** (if any):
1. [First suggested improvement]
2. [Second suggested improvement]

---

<details>
<summary><b>πŸ“‹ For full PR Review from agent, expand here</b></summary>

## 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]
Copy link

Copilot AI Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "Approval Checklist" section includes a placeholder line "[Add specific items relevant to this PR]" which could be confusing. This line should either be:

  1. Removed (since the list above already contains standard items)
  2. Changed to a comment/instruction like <!-- Add any PR-specific checklist items here -->
  3. Clarified as "- [ ] [Add any additional PR-specific items here]"

As currently written, it's ambiguous whether this text should appear literally in the output or is meant as an instruction to the agent.

Suggested change
[Add specific items relevant to this PR]
<!-- Add any PR-specific checklist items here -->

Copilot uses AI. Check for mistakes.

---

## 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]

</details>
```

### 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 `<details>` 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:
Expand Down