mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-02-21 18:49:56 +01:00
534c411fd8
## Summary of the Pull Request This PR adds comprehensive GitHub PR review tooling infrastructure to improve review efficiency through incremental review capabilities. The tooling consists of PowerShell scripts that detect changes between review iterations, enabling reviewers to focus only on modified files, and AI prompt templates for structured PR and issue reviews. **Key additions:** - `.github/review-tools/`: PowerShell scripts for incremental PR review detection - `.github/prompts/`: AI prompt templates for PR reviews, issue reviews, and issue fixes - Copilot instructions documentation for review tools integration ## PR Checklist - [ ] Closes: #xxx - [x] **Communication:** I've discussed this with core contributors already. If the work hasn't been agreed, this work might be rejected - [x] **Tests:** Added/updated and all pass (N/A - tooling scripts with manual validation) - [x] **Localization:** All end-user-facing strings can be localized (N/A - development tooling only) - [x] **Dev docs:** Added/updated (comprehensive documentation in `review-tools.instructions.md`) - [ N/A ] **New binaries:** Added on the required places (N/A - PowerShell scripts, no binaries) - [ N/A ] **Documentation updated:** If checked, please file a pull request on [our docs repo](https://github.com/MicrosoftDocs/windows-uwp/tree/docs/hub/powertoys) and link it here: #xxx (N/A - internal development tooling) ## Detailed Description of the Pull Request / Additional comments ### Review Tools Added (`.github/review-tools/`) **Core Scripts:** 1. **`Get-PrIncrementalChanges.ps1`** (173 lines) - Compares last reviewed commit SHA with current PR head to identify incremental changes. Returns JSON with changed files, new commits, and review recommendations. Handles scenarios: first review, no changes, force-push detection, and incremental changes. 2. **`Test-IncrementalReview.ps1`** (170 lines) - Helper script to preview incremental review detection before running full review. Displays colored console output showing current vs last reviewed SHAs, changed files, new commits, and recommended review strategy. 3. **`Migrate-ReviewToIncrementalFormat.ps1`** (206 lines) - One-time migration script to add review metadata sections to existing `00-OVERVIEW.md` files, enabling incremental review functionality for legacy PR reviews. 4. **`Get-GitHubRawFile.ps1`** (91 lines) - Downloads file content from GitHub repository at specific git reference for baseline comparison during reviews. Supports optional line numbering. 5. **`Get-GitHubPrFilePatch.ps1`** (79 lines) - Fetches unified diff (patch) for a specific file in a pull request using GitHub API. 6. **`review-tools.instructions.md`** (355 lines) - Comprehensive documentation covering script usage, workflow integration, error handling, best practices, and AI integration examples. Serves as Copilot instructions for the review tools. ### AI Prompt Templates Added (`.github/prompts/`) 1. **`review-pr.prompt.md`** (200 lines) - Structured prompt for comprehensive PR reviews with incremental review support 2. **`review-issue.prompt.md`** (158 lines) - Template for systematic issue analysis and triage 3. **`fix-issue.prompt.md`** (71 lines) - Guided workflow for implementing issue fixes 4. **Minor updates** to `create-commit-title.prompt.md` and `create-pr-summary.prompt.md` for consistency ### Key Features **Incremental Review Flow:** - Initial review (iteration 1): Creates overview with metadata including HEAD SHA - Subsequent reviews (iteration 2+): Reads last reviewed SHA, detects changes, reviews only modified files - Smart step filtering: Skips irrelevant review steps based on file types changed (e.g., skip Localization if no `.resx` files changed) **Error Handling:** - Detects force-push scenarios (last reviewed SHA no longer in history) - Validates GitHub CLI authentication - Provides detailed error messages with actionable solutions - Exit code 1 on errors for automation compatibility **Integration:** - Works with GitHub CLI (`gh`) for API access - JSON output for programmatic consumption - Designed for AI-powered review systems (Copilot integration) - Metadata tracking for context-aware suggestions ## Validation Steps Performed **Manual Testing:** 1. ✅ Verified all PowerShell scripts follow PSScriptAnalyzer rules 2. ✅ Tested `Get-PrIncrementalChanges.ps1` with various scenarios: - First review (no previous SHA) - No changes (SHA matches current) - Force-push detection (SHA not in history) - Incremental changes (multiple commits and files) 3. ✅ Validated `Test-IncrementalReview.ps1` output formatting and accuracy 4. ✅ Confirmed `Migrate-ReviewToIncrementalFormat.ps1` adds metadata without corrupting existing reviews 5. ✅ Tested GitHub API integration with `Get-GitHubRawFile.ps1` and `Get-GitHubPrFilePatch.ps1` 6. ✅ Verified documentation accuracy and completeness in `review-tools.instructions.md` 7. ✅ Validated prompt templates follow PowerToys repo conventions from `.github/copilot-instructions.md` **Dependencies Verified:** - Requires PowerShell 7+ (or Windows PowerShell 5.1+) - Requires GitHub CLI (`gh`) installed and authenticated - All scripts include comprehensive help documentation (`Get-Help` support) **No Automated Tests:** These are development/CI tooling scripts used by maintainers for PR reviews. Manual validation appropriate as they interact with live GitHub API and require human judgment for review quality assessment.