Document the requirements the SDK/CLI has for a project to interact with tooling.

[baronfel]

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

We should have some docs that describe dependencies (implicit or explicit) that the SDK/CLI tooling has on projects it interacts with. This may include things like:

• what MSBuild targets the various CLI commands map to
• info about RunCommand/RunArguments/LaunchProfiles and how they interact with dotnet run/dotnet watch
• the DefaultProjectTypeGuid MSBuild property and how it interacts with dotnet sln add

So that other teams looking to seamlessly work with the CLI have a set of guidelines they can target to light up various functionality.

[Forgind]

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

We should have some docs that describe dependencies (implicit or explicit) that the SDK/CLI tooling has on projects it interacts with. This may include things like:

• what MSBuild targets the various CLI commands map to

This is a bit confusing in that things can map to multiple targets or different targets depending on what options are passed in. The most obvious example is dotnet build, which clearly just invokes the Build target...except it also invokes Restore...and that's only by default, since you can also specify /t:...

• info about RunCommand/RunArguments/LaunchProfiles and how they interact with dotnet run/dotnet watch

Is this set in stone? This feels more like an implementation detail than something we really want customers to rely on.

• the DefaultProjectTypeGuid MSBuild property and how it interacts with dotnet sln add

What are you thinking of in this case? As far as I know, the project guids just indicate what kind of project something is so MSBuild knows whether it can build it or to what extent it can change it.

So that other teams looking to seamlessly work with the CLI have a set of guidelines they can target to light up various functionality.

[baronfel]

Also need to document the Run protocol described in #42155.

@Forgind re: your comments on the RunCommand stuff, yes we definitely need to document this, in addition to the way the LaunchProfiles interact with these properties. This is necessary information for any MSBuild SDK author that wants their projects to integrate with the dotnet CLI.

Further, if we document these things and we change the implementation to contradict the docs, we can determine if the change was intentional or not. As it is, without documentation, we have nothing but implicit knowledge keeping some of these contracts afloat.

re: DefaultProjectTypeGuid, this property is required in order to add a project to a solution - it's an explicit requirement of the solution format (at least at this point in time).