Skip to content

Commit

Permalink
added and altered readme files after moving dotnet new and templates (
Browse files Browse the repository at this point in the history
#27330)

* added and altered readme files after moving `dotnet new` and templates

* Update template_feed/README.md

Co-authored-by: Bekir Ozturk <60651445+bekir-ozturk@users.noreply.github.com>

Co-authored-by: Bekir Ozturk <60651445+bekir-ozturk@users.noreply.github.com>
  • Loading branch information
vlada-shubina and bekir-ozturk authored Aug 23, 2022
1 parent 24f543e commit 89d9c80
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This repo contains core functionality needed to create .NET projects that is sha

Please refer to [dotnet/project-system](https://github.com/dotnet/project-system) for the project system work that is specific to Visual Studio.

This repo also contains [common project and item templates](https://github.com/dotnet/sdk/tree/main/template_feed).

## Build status

|Windows x64 |
Expand Down
25 changes: 25 additions & 0 deletions src/Cli/dotnet/commands/dotnet-new/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## `dotnet new`

This is a home for `dotnet new` command.

The issues for `dotnet new` be opened in dotnet/sdk repo with label [`area: dotnet new`](https://github.com/dotnet/sdk/labels/area%3A%20dotnet%20new).

To contribute or debug, follow [`dotnet/sdk` guideline](https://github.com/dotnet/sdk#how-do-i-engage-and-contribute).

Main `muscles` of `dotnet new` are implemented in [`Microsoft.TemplateEngine.Cli`](https://github.com/dotnet/sdk/tree/main/src/Cli/Microsoft.TemplateEngine.Cli).
`dotnet` mainly contains the functionality that needs other `dotnet` tools, as:
- MSBuild evaluation and related components ([project capability constraint](https://github.com/dotnet/sdk/blob/main/src/Cli/dotnet/commands/dotnet-new/MSBuildEvaluation/ProjectCapabilityConstraint.cs), [project context symbol source](https://github.com/dotnet/sdk/blob/main/src/Cli/dotnet/commands/dotnet-new/MSBuildEvaluation/ProjectContextSymbolSource.cs))
- [post actions](https://github.com/dotnet/sdk/tree/main/src/Cli/dotnet/commands/dotnet-new/PostActions) running other `dotnet` commands
- providers for the template packages built-in to SDK, other SDK information and optional workloads

Consider adding unit tests and/or integration tests when contributing.
The unit tests are located in:
- [`dotnet` unit tests](https://github.com/dotnet/sdk/tree/main/src/Tests/dotnet.Tests/dotnet-new)
- [`Microsoft.TemplateEngine.Cli`](https://github.com/dotnet/sdk/tree/main/src/Tests/Microsoft.TemplateEngine.Cli.UnitTests)

The integration tests are located [here](https://github.com/dotnet/sdk/tree/main/src/Tests/dotnet-new.Tests).
Please follow existing tests to see how to run `dotnet new` under different conditions.

Assets for unit and integration tests are defined [here](https://github.com/dotnet/sdk/tree/main/src/Assets/TestPackages/dotnet-new).

To work with `dotnet new`, you may also use [solution filter](https://github.com/dotnet/sdk/blob/main/TemplateEngine.slnf).
24 changes: 24 additions & 0 deletions template_feed/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Common project and item templates

[.NET default templates](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-new-sdk-templates) are located in several repositories.

This folder contains common project and item templates:
- Console App (`console`)
- Class Library (`classlib`)
- .NET `gitignore` (`gitignore`)
- Editor config (`editorconfig`)
and some others

The issues for the content of these templates should be opened in dotnet/sdk repo with label [`Area-Templates`](https://github.com/dotnet/sdk/issues?q=is%3Aopen+is%3Aissue+label%3AArea-Templates).

The other templates are located in the following repositories:
| Templates | Repository |
|---|---|
|ASP.NET and Blazor templates|[dotnet/aspnetcore](https://github.com/dotnet/aspnetcore)|
|ASP.NET Single Page Application templates| [dotnet/spa-templates](https://github.com/dotnet/spa-templates)|
|WPF templates|[dotnet/wpf](https://github.com/dotnet/wpf)|
|Windows Forms templates|[dotnet/winforms](https://github.com/dotnet/winforms)|
|Test templates|[dotnet/test-templates](https://github.com/dotnet/test-templates)|
|MAUI templates|[dotnet/maui](https://github.com/dotnet/maui)|

Issues for the template content should be opened in the corresponding repository.

0 comments on commit 89d9c80

Please sign in to comment.