dotnet / dotnet/sdk

We need to document the ProjectCapability Items that the .NET SDK (and other SDKs in this repo) provide

Open
#52,984 0 comments 1 reaction 2 assignees Claimed by @baronfel View on GitHub
Area-NetSDK documentation untriaged
Dominant language
C#
Stars
3.2k
Forks
1.3k
PR merge metrics
PR metrics pending

Description

### Is your feature request related to a problem? Please describe.

`ProjectCapability` MSBuild Items are declarative data that IDEs and CLI experiences (like SDK Container publishing and `dotnet run`) use to determine if a specific action or feature can be used by a given project. This set is documented somewhat at https://github.com/microsoft/vsprojectsystem/blob/master/doc/overview/project_capabilities.md, but we've certainly added more over time. We should have a place to document these items, what they mean, and what experiences (IDE and CLI) they enable.

### Describe the solution you'd like

We need two things:
* new in-repo documentation for the project capabilities provided in the .NET SDK, with separate documentation files for each 'MSBuild SDK' that provides capabilities. This gets us 'green' with the current state.
* a new github actions workflow that detects when a PR includes a new ProjectCapability and reminds the author to add/update the existing in-repo documentation. This keeps us 'green' for the future.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.