Add overview section to copilot-instructions.md#55055
Merged
Merged
Conversation
Document what the SDK does, its architecture, key files, build/test commands, and the feature/config story. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an “Overview” section to .github/copilot-instructions.md to orient Copilot/agents to the .NET SDK repo, including what the SDK owns, high-level architecture, key directories, and common build/test/dogfood workflows.
Changes:
- Documented repo purpose/ownership boundaries and how
dotnetcommand resolution works at a high level. - Added a “major source areas” map for
src/and a “key files/directories” list. - Added quick-start build/test/dogfood scenarios and pointers to README + Developer Guide.
Replace hard-coded Debug redist paths with a <configuration> placeholder (Debug by default) so guidance doesn't mislead Release builders. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fix missing word and reword awkward inline-code phrasing for readability. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The example previously claimed the repo-local .dotnet while running a bare dotnet. Use plain `dotnet` so the command works in either a global or dogfood scenario. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
lbussell
reviewed
Jun 30, 2026
The full suite is very large and long-running; steer agents toward targeted test-project/test runs and the incremental-test skill instead of build.cmd -test. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replace the ambiguous bare-`dotnet` vs `./.dotnet/dotnet` guidance with the canonical build-env approach: build, then load sdk-build-env so a plain `dotnet` resolves correctly. Tie the Overview single-test example to the same flow so the two sections agree. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
lbussell
reviewed
Jun 30, 2026
Keep test/restore scripts listed as key files (they orient newcomers to what is in the repo root) but note they are thin wrappers that forward to build.cmd/build.sh, so it is clear which entry point to use. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
… -method The repo's unit tests (e.g. dotnet.Tests) run on Microsoft.Testing.Platform via MSTest.Sdk, so the xUnit -method argument is not recognized. Validated ./.dotnet/dotnet exec <assembly>.dll --filter <name> against a fresh build. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
lbussell
approved these changes
Jul 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Document what the SDK does, its architecture, key files, build/test commands, and the feature/config story.