Enhanced GitHub Copilot instructions with build validation and CI failure prevention #2366
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR enhances the existing
.github/copilot-instructions.md
file with critical information to reduce CI failures and improve AI agent efficiency when working with the MSAL Android repository.Problem Statement
While the repository already had comprehensive MSAL-specific instructions, AI agents were still experiencing CI failures due to missing build validation steps, unclear testing requirements, and lack of troubleshooting guidance for common development issues.
Solution
Enhanced the existing copilot instructions with:
Quick Start Section
Added an immediate reference guide for AI agents with essential first steps:
Ai.md
,snippets/
,examples/
)Build & Test Validation
Documented the exact Gradle commands that match the CI pipeline:
CI Failure Prevention
Added specific guidance for common failure scenarios:
Development Environment Standards
Documented critical environment requirements:
Pre-submission Checklist
Created a comprehensive validation checklist that agents can follow before submitting PRs to ensure CI success.
Troubleshooting Guide
Added solutions for common issues with builds, tests, linting, and configuration that agents frequently encounter.
Impact
This enhancement directly addresses the stated goals:
The enhanced instructions maintain the existing comprehensive MSAL-specific guidance while adding essential repository-level development practices that ensure CI compatibility.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
dl.google.com
If you need me to access, download, or install something from one of these locations, you can either:
💡 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.