-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Improve AI agent documentation and testing instructions #32485
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR extracts documentation improvements for the PR review workflow from PR #32405, specifically updating .github/agents/pr-reviewer.md to introduce dynamic branch tracking instead of hardcoded branch references.
Key changes:
- Introduces
ORIGINAL_BRANCHvariable to capture and preserve the reviewer's starting branch context - Updates all cleanup sections to use this variable for reliable return to starting state
- Improves clarity with fallback instructions when the variable isn't available
91a607a to
ffe8f71
Compare
Updated the PR description to reflect all changes made across the 6 commits. The PR has evolved significantly beyond the original pr-reviewer.md updates to include:
Total: 1,034 additions, 566 deletions across 12 files. |
Co-authored-by: PureWeen <[email protected]>
# Conflicts: # AGENTS.md
ffe8f71 to
6d7d825
Compare
|
/azp run MAUI-public |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Note
Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!
Description of Change
This PR consolidates and improves AI agent documentation and testing instructions for the .NET MAUI repository. It includes comprehensive improvements to testing workflows, instruction organization, and new guidance documents.
Major Changes
1. New Instruction Files
📄
.github/instructions/appium-control.instructions.md(369 lines)📄
.github/instructions/common-testing-patterns.md(397 lines)2. Enhanced Existing Instructions
.github/agents/pr-reviewer.md(+98 lines)ORIGINAL_BRANCHvariable to replace hardcoded "pr-reviewer" references.github/instructions/uitests.instructions.md(+118 lines).github/instructions/instrumentation.instructions.md(+47 lines).github/copilot-instructions.md(+32 lines)3. Repository Organization
Removed:
AGENTS.md(-521 lines).github/instructions/directoryUpdated:
.github/README-AI.md(+2 lines)Updated:
.gitignore(+1 line)4. Documentation Updates
docs/UITesting-Guide.md(+8 lines)docs/PR-Test-Validation-Guide.md(+5 lines)5. Sample Code Updates
src/Controls/samples/Controls.Sample.Sandbox/Platforms/Android/MainActivity.cs(+2 lines)Statistics
Benefits
✅ Better organization - Focused instruction files instead of monolithic documents
✅ Reduced duplication - Common patterns extracted to reusable reference document
✅ Improved discoverability - Cross-references between related instructions
✅ Enhanced testing workflows - Comprehensive Appium and testing guidance
✅ Easier maintenance - Single source of truth for common patterns
✅ Better agent guidance - Clearer, more actionable instructions
Issues Fixed
N/A - Documentation and instruction improvements
Includes pr-reviewer.md updates from PR #32405
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.