Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 1, 2025

Enhanced the .github/copilot-instructions.md file 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=Disabled is 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:

  • Initial setup with ./init.ps1 or pwsh ./init.ps1
  • Building with ./build.ps1 or pwsh ./build.ps1
  • Testing with dotnet 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.ms
    • Triggering command: curl -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.

Copilot AI changed the title [WIP] update the copilot instructions file Update copilot instructions with comprehensive guidance for shallow clone environment Sep 1, 2025
Copilot AI requested a review from AArnott September 1, 2025 21:57
* Run all tests: `dotnet test --filter "TestCategory!=FailsInCloudTest"`
* The filter excludes unstable tests that are known to fail in cloud environments
* Tests use the Xunit testing framework
* All tests should pass when `NBGV_GitEngine=Disabled` is set
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wonder... is this true? Does that defeat any of the tests? We certainly don't regularly test with such an environment variable set.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants