-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Restructure copilot-instructions.md to emphasize mandatory baseline build #123067
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
|
/ba-g markdown only |
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 restructures the copilot-instructions.md document to address issues where the coding agent was skipping baseline setup steps, causing "missing testhost" and "shared framework" errors. The restructure moves the baseline build instructions to a prominent first section with mandatory warning emphasis and consolidates the document from ~325 to ~150 lines.
Changes:
- Moved baseline build to first section with "
⚠️ MANDATORY" heading and explicit warnings about consequences of skipping - Replaced verbose bullet lists with scannable tables for component identification and build commands
- Removed table of contents and consolidated iterative strategy, troubleshooting, and reference sections into compact formats
Comments suppressed due to low confidence (2)
.github/copilot-instructions.md:73
- The instruction to switch back to the working branch after the baseline build is missing. After completing the baseline build on main (Step 2) and configuring the environment (Step 3), the agent needs to switch back to the working branch before applying changes. Without this step, the agent would apply changes to the main branch instead of the working branch. Add an instruction at the end of Step 3, e.g., "Then switch back to your working branch before making changes."
**Only proceed with changes after the baseline build succeeds.** If it fails, report the failure and stop.
.github/copilot-instructions.md:79
- The iterative build and test strategy guidance has been removed, including important details about retry attempts (up to 5 attempts for build failures, test build failures, and test failures), how to handle different types of test failures, and when to escalate. This guidance helps the agent know when to retry vs when to report failure. While this might reduce verbosity, it may lead to the agent giving up too early or retrying indefinitely without clear boundaries. Consider adding a brief note about retry strategy, such as: "If builds or tests fail, attempt to fix and retry up to 5 times with different approaches before reporting failure."
After completing the baseline build above, use the appropriate workflow for your changes.
|
@copilot address the feedback please |
Addressed all feedback in 98963cc:
|
jkoritzinsky
left a comment
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.
@copilot please address the feedback in this review.
Added all requested entries in 4754fd9:
|
…uild first Co-authored-by: stephentoub <[email protected]>
4754fd9 to
c965e5b
Compare
|
/ba-g markdown only |
Description
The coding agent was skipping baseline setup steps before building/running tests, causing "missing testhost" and "shared framework" errors. Restructured instructions to make baseline build impossible to miss.
Key changes:
Restored guidance per feedback:
Added new components per feedback:
src/tools,src/native/managed,src/tasks,src/teststo component identification tableCustomer Impact
N/A - Internal tooling instructions only.
Regression
No.
Testing
Documentation-only change. Verified no trailing whitespace per markdown guidelines.
Risk
Low. No code changes. Core guidance retained; only organization and emphasis changed.
Package authoring no longer needed in .NET 9
IMPORTANT: Starting with .NET 9, you no longer need to edit a NuGet package's csproj to enable building and bump the version.
Keep in mind that we still need package authoring in .NET 8 and older versions.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.