Skip to content

update template descriptions to be more beginner-friendly #48609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

gkulin
Copy link
Member

@gkulin gkulin commented Apr 21, 2025

Making this change so that template descriptions in the .NET template engine can be more beginner-friendly

@Copilot Copilot AI review requested due to automatic review settings April 21, 2025 22:15
@gkulin gkulin requested a review from a team as a code owner April 21, 2025 22:15
@dotnet-issue-labeler dotnet-issue-labeler bot added Area-Common templates Covers templates in the repo (classlib, console, common item templates) untriaged Request triage from a team member labels Apr 21, 2025
Copy link
Contributor

@Copilot 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

This PR updates template descriptions in the .NET template engine and corresponding tests to be more beginner-friendly.

  • Updated descriptions for the console and class library templates.
  • Adjusted documentation strings in various approval tests to reflect clearer, simplified language.

Reviewed Changes

Copilot reviewed 7 out of 20 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
test/dotnet-new.IntegrationTests/Approvals/DotnetNewHelpTests.CanShowHelpForTemplate_console.verified.txt Console app description updated.
test/dotnet-new.IntegrationTests/Approvals/DotnetNewHelpTests.CanShowHelpForTemplate_classlib.verified.txt Class library description updated.
test/dotnet-new.IntegrationTests/Approvals/DotnetNewHelpTests.CanShowHelpForTemplate_MatchOnLanguage.verified.txt Console app (F#) description updated.
test/dotnet-new.IntegrationTests/Approvals/DotnetNewHelpTests.CanShowHelpForTemplate_MatchOnChoice.verified.txt Console app description updated.
test/Microsoft.TemplateEngine.Cli.UnitTests/ParserTests/Approvals/TabCompletionTests.RootCommand_GetStartsWtihSuggestions.verified.txt Documentation string updated for class library and console templates.
test/Microsoft.TemplateEngine.Cli.UnitTests/ParserTests/Approvals/TabCompletionTests.RootCommand_GetAllSuggestions.verified.txt Documentation string updated for class library and console templates.
test/Microsoft.TemplateEngine.Cli.UnitTests/ParserTests/Approvals/TabCompletionTests.Create_GetAllSuggestions.verified.txt Documentation string updated for class library and console templates.
Files not reviewed (13)
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ClassLibrary-CSharp/.template.config/localize/templatestrings.en.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ClassLibrary-CSharp/.template.config/template.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ClassLibrary-FSharp/.template.config/localize/templatestrings.en.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ClassLibrary-FSharp/.template.config/template.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ClassLibrary-VisualBasic/.template.config/localize/templatestrings.en.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ClassLibrary-VisualBasic/.template.config/template.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ConsoleApplication-CSharp/.template.config/localize/templatestrings.en.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ConsoleApplication-CSharp/.template.config/template.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ConsoleApplication-FSharp/.template.config/localize/templatestrings.en.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ConsoleApplication-FSharp/.template.config/template.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ConsoleApplication-VisualBasic/.template.config/localize/templatestrings.en.json: Language not supported
  • template_feed/Microsoft.DotNet.Common.ProjectTemplates.10.0/content/ConsoleApplication-VisualBasic/.template.config/template.json: Language not supported
  • test/dotnet-new.IntegrationTests/Approvals/DotnetNewHelpTests.CanShowHelpForTemplate_MatchOnNonChoiceParam.verified.txt: Language not supported

@gkulin
Copy link
Member Author

gkulin commented May 6, 2025

thank you for your feedback @KalleOlaviNiemitalo! Re-requesting review :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Common templates Covers templates in the repo (classlib, console, common item templates) untriaged Request triage from a team member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants