Skip to content

Clarify Default includes and excludes section in .NET project SDK overview#52482

Open
Copilot wants to merge 4 commits intomainfrom
copilot/clarify-default-compilation-includes
Open

Clarify Default includes and excludes section in .NET project SDK overview#52482
Copilot wants to merge 4 commits intomainfrom
copilot/clarify-default-compilation-includes

Conversation

Copy link
Contributor

Copilot AI commented Mar 20, 2026

The "Default includes and excludes" section was vague about what each item type does, didn't explain the glob column semantics, and left the "Remove glob" column unexplained—leading users to incorrectly assume they should add these globs to their project files.

Changes

  • Opening paragraph → bulleted list: Now explicitly describes what Compile, EmbeddedResource, and None items do (compiled into assembly / embedded in assembly / tracked but not compiled or embedded).
  • Glob terminology defined before the table: New bullet list defines include/exclude/remove glob so the table columns are self-explanatory.
  • None's remove glob explained: Added a paragraph after the table clarifying that None uses **/* as its include, so the SDK removes **/*.cs and **/*.resx to prevent those files from appearing in both None and their primary item types simultaneously.
  • Warning promoted to [!WARNING] admonition: The original plain-text sentence was easy to miss. Rewritten as a [!WARNING] block with a clearer message: the SDK already includes these items—don't define them again.
Original prompt

This section details on the original issue you should resolve

<issue_title>The Default Compilation Includes section is confusing and possibly misleading</issue_title>
<issue_description>An example of what some of these permutations would translate to in a proj file would probably help clarify.

Like what does the <None ... element's "Remove Glob" actually do?

This also implies that globbing syntax can be used in a proj file but Im not seeing that actually working.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

<agent_instructions>The opening paragraph in this section could use more detail on what these items do for your project, and the callout for not modifying them could be stronger.</agent_instructions>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.


Internal previews

📄 File 🔗 Preview link
docs/core/project-sdk/overview.md .NET project SDKs

Co-authored-by: BillWagner <493969+BillWagner@users.noreply.github.com>
Copilot AI changed the title [WIP] Update Default Compilation Includes section for clarity Clarify Default includes and excludes section in .NET project SDK overview Mar 20, 2026
Copilot AI requested a review from BillWagner March 20, 2026 14:40
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

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

This is ready for final review.

@BillWagner BillWagner marked this pull request as ready for review March 20, 2026 23:35
@BillWagner BillWagner requested review from a team and gewarren as code owners March 20, 2026 23:35
Copilot AI review requested due to automatic review settings March 20, 2026 23:35
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Improves the Default includes and excludes section in the .NET project SDK overview to reduce confusion about what the SDK implicitly includes, how the glob table should be read, and why None has a remove glob.

Changes:

  • Replaces the prior opening paragraph with a bulleted explanation of Compile, EmbeddedResource, and None item types.
  • Adds pre-table definitions for include, exclude, and remove glob semantics.
  • Adds a post-table explanation for None’s remove glob, and upgrades the duplicate-items guidance to a [!WARNING] admonition.

BillWagner and others added 2 commits March 20, 2026 19:46
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The Default Compilation Includes section is confusing and possibly misleading

4 participants