Add per-template onboarding READMEs for C# WinUI 3 templates#6491
Open
DinahK-2SO wants to merge 10 commits into
Open
Add per-template onboarding READMEs for C# WinUI 3 templates#6491DinahK-2SO wants to merge 10 commits into
DinahK-2SO wants to merge 10 commits into
Conversation
Delete Agents.md and 9 .instructions.md files. Add a new README.md covering project layout, prerequisites, and build/run steps. Update the packaging task to emit README.md.
…ion files for dotnet-new and VSIX channels
…pe dotnet pack source
DinahK-2SO
changed the title
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
DinahK-2SO
requested review from
lei9444 and
yeelam-gordon
and removed request for
lei9444 and
yeelam-gordon
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
- Rename 13 per-template outline files (6 dotnet + 7 VSIX) from README.md to AGENTS.md via git mv (history preserved). - Update VSIX twin csprojs <TemplateReadme> paths, dotnet pack inline task (ExpandProjectTemplatePackItems), Directory.Build.targets, .vstemplate ProjectItem entries, .gitignore, validation script, and how-to doc to reference AGENTS.md. - Preserve dev/Templates/Dotnet/README.md and <PackageReadmeFile>README.md</PackageReadmeFile> (NuGet package landing-page README must stay named README.md). - Shorten TemplateReadmeSections/*.md to a brief pattern: H2 heading + 3-6 action-oriented bullets + 1 external doc link. No duplication of authoritative external instructions. - Validated locally with VS Enterprise 2022 MSBuild: all 7 VSIX twin csprojs build clean in Release (0 errors, 0 VSSDK1016, 0 NU5118).
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Contributor
Author
|
TODO: remove the folder |
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Contributor
Author
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Following the discussion in #6407, the blank-app template gets a single onboarding README instead of the originally proposed
.github/instructions/agent-rules folder. The README keeps the WinAppSDK-specific tips a new project owner needs on day one, framed as encouragement rather than enforcement.The PR also extends the same approach to five sibling templates (
class-library,mvvm-app,navigation-app,tabview-app,unit-test), each assembled at build time from a shared section library so the READMEs stay consistent.The authoring guide is added in:
dev/Templates/how-to-create-a-new-csharp-template.md.Tips intentionally not carried over
mvvm-apptemplate.ObservableObject,[ObservableProperty],[RelayCommand])Microsoft.Extensions.DependencyInjectionsetupViews/,ViewModels/,Services/)NavigationView+Frame+INavigationServicenavigation-apptemplate; the blank template ships a singleMainPage.Microsoft.UI.Xaml.*vsWindows.UI.Xaml.*namespace pitfallWindow.Current/CoreDispatcherremoval notesREGDB_E_CLASSNOTREGrecovery viawinapp unregisterwinappCLI docs already cover it.ThemeResource, Mica backdrop, custom title bar,AppWindow.ResizeMicrosoft.CodeAnalysis.NetAnalyzers,StyleCop.AnalyzerspackagesEnableNETAnalyzers,EnforceCodeStyleInBuild,Nullable=enablesettings.csprojas it ships..editorconfig(file-scoped namespaces,_camelCase,Asyncsuffix)stylecop.json, naming-convention table, file-organization orderMicrosoft.Windows.Apps.Teststackunit-testtemplate is the right home. README already points to it in Common next steps.MethodName_Scenario_ExpectedResultnamingdotnet test --filterfor subset runsAutomationProperties.AccessibilityView="Raw"for decorative imagesnet10.0; pass--dotnet-version <tfm>to override"dotnet newUX. No need to duplicate in the README.