Update copilot instructions with comprehensive guidance for shallow clone environment #1259
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.
Enhanced the
.github/copilot-instructions.mdfile to provide comprehensive guidance specifically tailored for the GitHub Copilot Coding Agent working in a shallow clone environment.Key Improvements
Environment Setup Clarification: Added a dedicated section explaining why
NBGV_GitEngine=Disabledis required when working with Nerdbank.GitVersioning in shallow clone environments. The GitHub Copilot Coding Agent operates on shallow clones by default, which breaks version calculation that depends on git history.Step-by-Step Build Instructions: Expanded the build guidance with specific commands and workflow:
./init.ps1orpwsh ./init.ps1./build.ps1orpwsh ./build.ps1dotnet test --filter "TestCategory!=FailsInCloudTest"Enhanced Testing Guidelines: Provided clearer guidance on running tests, including the rationale for filtering out unstable tests that fail in cloud environments, and emphasized the importance of comprehensive test coverage.
Improved Structure and Organization: Reorganized content into logical sections with clear headers and better flow, making it easier for the Copilot agent to find relevant information quickly.
Coding Standards Enhancement: Expanded the coding style section with additional guidance on following existing patterns, meaningful naming conventions, and comprehensive documentation requirements.
These changes ensure that the Copilot Coding Agent has all the necessary information to work effectively with this repository, avoiding common pitfalls related to shallow clones and providing clear guidance for building, testing, and maintaining code quality standards.
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:
aka.mscurl -I -sSL --retry 5 --retry-delay 2 --connect-timeout 15 REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.