Skip to content

Commit

Permalink
Merge pull request #4365 from microsoft/dev
Browse files Browse the repository at this point in the history
Sync latest from dev
  • Loading branch information
prupipho authored Jun 25, 2021
2 parents 1e7996e + cd91d1a commit 96f1d4c
Show file tree
Hide file tree
Showing 985 changed files with 6,852 additions and 4,048 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to Windows Template Studio

The foundation of **Windows Template Studio** is get a developer's File->New Project experience up and going as fast possible.
The foundation of *Windows Template Studio* is get a developer's `File -> New Project` experience up and going as fast possible.

A developer should be able to quickly and easily add features, pages, and have a solid foundation to start with. The starting code and XAML will be best practices, follow design guidelines and be commented to help aid in enabling everything a developer to get started and understand **why** something is like it is.

Expand All @@ -12,17 +12,17 @@ Also remember that the Pull Requests must be done against the **[dev branch](htt

While we're grateful for any and all contributions, we don't want you to waste anyone's time. Please consider the following points before you start working on any contribution.

* Please comment on an issue to let us know you're interested in working on something before you start the work. Not only does this avoid multiple people unexpectedly working on the same thing at the same time but it enables us to make sure everyone is clear on what should be done to implement any new functionality. It's less work for everyone, in the long run, to establish this up front.
* Please comment on an [issue](https://github.com/microsoft/WindowsTemplateStudio/issues) to let us know you're interested in working on something before you start the work. Not only does this avoid multiple people unexpectedly working on the same thing at the same time but it enables us to make sure everyone is clear on what should be done to implement any new functionality. It's less work for everyone, in the long run, to establish this up front.
* The code that is output in the generated projects may end up in thousands of apps so it must be of the highest quality. Expect it to be reviewed very thoroughly and it must meet our standards for standards for style, structure, and format. There are details below and automated tests to verify their use.
* Get familiar with the automated tests that are part of the project. With so many possible combinations of output, it's impossible to verify everything manually. You will need to make sure they all pass.
* When adding anything new it should be created to work with all supported frameworks. If this is going to be a problem, discuss it before beginning work.
* We support templates for apps built with both C# and VB.Net but appreciate that not evevryone wants to work in both languages. For this reason we have a C#-first approach. This approach means that new functionality if first created in the C# templates and the VB.Net version is created after. If contributing something it is ok to submit a PR that just contains the C# version. For all non-code files (xaml, images, etc.) the different language versions should use identical copies of files. The VB templates contain a copy of such files so that it is possible to change the templates for each language separately.
* We support templates for apps built with both C# and VB.Net but appreciate that not evevryone wants to work in both languages. For this reason we have a C#-first approach. This approach means that new functionality is first created in the C# templates and the VB.Net version is created after. If contributing something it is ok to submit a PR that just contains the C# version. For all non-code files (xaml, images, etc.) the different language versions should use identical copies of files. The VB templates contain a copy of such files so that it is possible to change the templates for each language separately.

## A good pull request

Every contribution has to come with:

* Before starting coding, **you must open an issue** and start discussing with the community to see if the idea/feature is interesting enough.
* Before starting coding, **you must open an [issue](https://github.com/microsoft/WindowsTemplateStudio/issues)** and start discussing with the community to see if the idea/feature is interesting enough.
* A documentation page in the [documentation folder](https://github.com/Microsoft/WindowsTemplateStudio/tree/release/docs).
* Unit tests (If applicable, or an explanation why they're not)

Expand All @@ -31,13 +31,13 @@ Every contribution has to come with:
- Be sure you have reviewed the [accesibility checklist](docs/accessibility.md).

* If you've included a new template:
- Be sure you reviewed the [Template Verification Checklist](https://github.com/Microsoft/WindowsTemplateStudio/wiki/Template-Verification-Checklist).
- Be sure you reviewed the [Template Verification Checklist](https://github.com/microsoft/WindowsTemplateStudio/wiki/Checklist:-Template-Verification).

* You tested your code with two most recent Windows 10 SDKs. (Build 18362 and 19041)
* You've run all existing tests to make sure you've not broken anything.
* PR has to target dev branch.

PR has to be validated by at least two core members before being merged. Once merged, it will be in the pre-release package. To find out more, head to [Installing / Using the extension](docs/getting-started-extension.md).
PR has to be validated by at least two core members before being merged. Once merged, it will be in the next dev-nightly package. To find out more, head to [Installing / Using the extension](docs/getting-started-extension.md).

## Quality insurance for pull requests for XAML

Expand All @@ -48,11 +48,11 @@ We encourage developers to follow the following guidances when submitting pull r
* Focused controls must be visible.
* Action must be triggered when hitting Enter key.
* Do not use custom colors but instead rely on theme colors so high contrasts themes can be used with your control.
* Add AutomationProperties.Name on all controls to define what the controls purpose (Name is minimum, but there are some other things too that can really help the screen reader).
* Add `AutomationProperties.Name` on all controls to define what the controls purpose (Name is minimum, but there are some other things too that can really help the screen reader).
* Don't use the same Name on two different elements unless they have different control types.
* Use Narrator Dev mode (Launch Narrator [WinKey+Enter], then CTRL+F12) to test the screen reader experience. Is the information sufficient, meaningful and helps the user navigate and understand your control.
* Use Narrator Dev mode (Launch Narrator `WinKey+Enter`, then `CTRL+F12`) to test the screen reader experience. Is the information sufficient, meaningful and helps the user navigate and understand your control?

You can find more information about these topics [here](https://blogs.msdn.microsoft.com/winuiautomation/2015/07/14/building-accessible-windows-universal-apps-introduction). This is to help as part of our effort to building accessible templates from the start.
You can find more information about these topics [here](https://blogs.msdn.microsoft.com/winuiautomation/2015/07/14/building-accessible-windows-universal-apps-introduction). This is to help as part of our effort to building accessible templates from the start.

## General rules

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Windows Template Studio

Windows Template Studio (WinTS) is a Visual Studio 2019 Extension that accelerates the creation of new Universal Windows Platform (UWP), Windows Presentation Foundation (WPF .NET Core 3.1) and WinUI 3 in Desktop apps using a wizard-based experience. The resulting project is well-formed, readable code that incorporates great development features while implementing proven patterns and best practices. Sprinkled throughout the generated code we have links to documentation to provide useful insights. WinTS supports creating UWP apps in C# or VB.Net, WPF (.NET Core 3.1) apps in C# and WinUI 3 in Desktop apps in C# or C++.
*Windows Template Studio* (aka *WinTS*) is a Visual Studio 2019 Extension that accelerates the creation of new **Universal Windows Platform (UWP)**, **Windows Presentation Foundation (WPF .NET Core 3.1)** and **WinUI 3 in Desktop** apps using a wizard-based experience. The resulting project is well-formed, readable code that incorporates great development features while implementing proven patterns and best practices. Sprinkled throughout the generated code we have links to documentation to provide useful insights.
*WinTS* supports creating UWP apps in C# or VB.Net, WPF (.NET Core 3.1) apps in C# and **WinUI 3 in Desktop** apps in C# or C++.

![Windows Template Studio UWP screenshot](./docs/resources/getting-started/WTS%20-%20Project%20Type.png)

![Windows Template Studio WPF screenshot](./docs/resources/getting-started/WTSProjectTypeWPF.png)

![Windows Template Studio WinUI 3 screenshot](./docs/resources/getting-started/WTSProjectTypeWinUI.png)
![Windows Template Studio **WinUI 3** screenshot](./docs/resources/getting-started/WTSProjectTypeWinUI.png)

Note: :heavy_exclamation_mark: WinUI 3 Templates are still in development and will be available from version 4.0 onwards. You can get a preview using our dev-nightly version. Find more instructions on installing the dev-nightly at https://github.com/microsoft/WindowsTemplateStudio/blob/dev/docs/getting-started-extension.md#nightly--pre-release-feeds-for-windows-template-studio :heavy_exclamation_mark:
## Build Status

|Branch |CI |Test Version|Version|
Expand All @@ -30,7 +30,7 @@ Note: :heavy_exclamation_mark: WinUI 3 Templates are still in development and wi
## Features

Windows Template Studio approaches app creation using the following six attribute sets:
*Windows Template Studio* approaches app creation using the following six attribute sets:

### **Project type**

Expand All @@ -40,7 +40,7 @@ First, how do you want your app's UI navigation to behave?

- **WPF**: *[Blank](./docs/WPF/projectTypes/blank.md)*, *[Navigation Pane](./docs/WPF/projectTypes/navigationpane.md)*, *[Menu Bar](./docs/WPF/projectTypes/menubar.md)* and a *[Ribbon](./docs/WPF/projectTypes/ribbon.md)*.

- **WinUI 3**: *[Blank](./docs/WinUI/projectTypes/blank.md)*, *[Navigation Pane](./docs/WinUI/projectTypes/navigationpane.md)*.
- **WinUI 3**: *[Blank](./docs/WinUI/projectTypes/blank.md)*, *[Blank Advanced](./docs/WinUI/projectTypes/blankadvanced.md)*, *[Navigation Pane](./docs/WinUI/projectTypes/navigationpane.md)*, *[Menu Bar](./docs/WinUI/projectTypes/menubar.md)*.


### **App design pattern**
Expand Down Expand Up @@ -84,7 +84,7 @@ After selecting the items wanted in your app, you can extend the generated code

## Known issues

- You can't have side-by-side versions (nightly/pre-release/release) of Windows Template Studio VSPackage into a single instance of Visual Studio.
- You can't have side-by-side versions (nightly/pre-release/release) of *Windows Template Studio* VSPackage into a single instance of Visual Studio.

## Feedback, Requests and Roadmap

Expand Down
9 changes: 9 additions & 0 deletions code/Big.sln
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "VB", "VB", "{C8EAD987-3400-
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "CS", "CS", "{2B43B990-4F75-4E00-B52E-89C219B69B98}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "VsTemplates.Test", "test\VsTemplates.Test\VsTemplates.Test.csproj", "{1C2914D6-62F7-4C27-8A52-766F02AE2BC3}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Analyze|Any CPU = Analyze|Any CPU
Expand Down Expand Up @@ -339,6 +341,12 @@ Global
{2B30F12F-738D-470C-A317-0535BC9927E5}.Debug|Any CPU.Build.0 = Debug|Any CPU
{2B30F12F-738D-470C-A317-0535BC9927E5}.Release|Any CPU.ActiveCfg = Release|Any CPU
{2B30F12F-738D-470C-A317-0535BC9927E5}.Release|Any CPU.Build.0 = Release|Any CPU
{1C2914D6-62F7-4C27-8A52-766F02AE2BC3}.Analyze|Any CPU.ActiveCfg = Debug|Any CPU
{1C2914D6-62F7-4C27-8A52-766F02AE2BC3}.Analyze|Any CPU.Build.0 = Debug|Any CPU
{1C2914D6-62F7-4C27-8A52-766F02AE2BC3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{1C2914D6-62F7-4C27-8A52-766F02AE2BC3}.Debug|Any CPU.Build.0 = Debug|Any CPU
{1C2914D6-62F7-4C27-8A52-766F02AE2BC3}.Release|Any CPU.ActiveCfg = Release|Any CPU
{1C2914D6-62F7-4C27-8A52-766F02AE2BC3}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down Expand Up @@ -387,6 +395,7 @@ Global
{E744A488-119A-4E0C-8048-589AAFDB9BC9} = {428D8EC8-DF58-4921-B464-967086C924A4}
{C8EAD987-3400-4811-B744-6532E62C268D} = {AA547A22-5B7C-4B2A-9F5B-4F4140109CFF}
{2B43B990-4F75-4E00-B52E-89C219B69B98} = {E744A488-119A-4E0C-8048-589AAFDB9BC9}
{1C2914D6-62F7-4C27-8A52-766F02AE2BC3} = {481CC407-92E7-42A9-AD6E-AA157E5D40C3}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {93C24858-2871-47D7-8B91-2DD60E633C6B}
Expand Down
2 changes: 1 addition & 1 deletion code/CoreTemplateStudio
2 changes: 1 addition & 1 deletion code/Installer.sln
Original file line number Diff line number Diff line change
Expand Up @@ -295,4 +295,4 @@ Global
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {C5812CB4-61BE-4BBF-9613-A76CDB14E09C}
EndGlobalSection
EndGlobal
EndGlobal
12 changes: 10 additions & 2 deletions code/Test.sln
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio 15
VisualStudioVersion = 15.0.27004.2009
# Visual Studio Version 16
VisualStudioVersion = 16.0.31229.75
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Templates.Test", "test\Templates.Test\Templates.Test.csproj", "{1EE12A16-FE11-43AD-B509-668CE5D0DB16}"
EndProject
Expand Down Expand Up @@ -32,6 +32,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Utilities.Test", "CoreTempl
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WtsPackagingTool", "CoreTemplateStudio\code\tools\WtsPackagingTool\WtsPackagingTool.csproj", "{18FE7361-241E-4B1B-98F5-C4A4D17496A0}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "VsTemplates.Test", "test\VsTemplates.Test\VsTemplates.Test.csproj", "{1687FD9B-261D-401C-B34E-82E6B7A35868}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Analyze|Any CPU = Analyze|Any CPU
Expand Down Expand Up @@ -105,6 +107,12 @@ Global
{18FE7361-241E-4B1B-98F5-C4A4D17496A0}.Debug|Any CPU.Build.0 = Debug|Any CPU
{18FE7361-241E-4B1B-98F5-C4A4D17496A0}.Release|Any CPU.ActiveCfg = Release|Any CPU
{18FE7361-241E-4B1B-98F5-C4A4D17496A0}.Release|Any CPU.Build.0 = Release|Any CPU
{1687FD9B-261D-401C-B34E-82E6B7A35868}.Analyze|Any CPU.ActiveCfg = Debug|Any CPU
{1687FD9B-261D-401C-B34E-82E6B7A35868}.Analyze|Any CPU.Build.0 = Debug|Any CPU
{1687FD9B-261D-401C-B34E-82E6B7A35868}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{1687FD9B-261D-401C-B34E-82E6B7A35868}.Debug|Any CPU.Build.0 = Debug|Any CPU
{1687FD9B-261D-401C-B34E-82E6B7A35868}.Release|Any CPU.ActiveCfg = Release|Any CPU
{1687FD9B-261D-401C-B34E-82E6B7A35868}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
12 changes: 6 additions & 6 deletions code/src/Installer/Installer.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -300,16 +300,16 @@
<Content Include="Packages\microsoft.windows.cppwinrt.2.0.210211.2.nupkg">
<IncludeInVSIX>true</IncludeInVSIX>
</Content>
<Content Include="Packages\microsoft.projectreunion.0.5.7.nupkg">
<Content Include="Packages\microsoft.projectreunion.0.8.0-preview.nupkg">
<IncludeInVSIX>true</IncludeInVSIX>
</Content>
<Content Include="Packages\microsoft.projectreunion.dwrite.0.5.7.nupkg">
<Content Include="Packages\microsoft.projectreunion.dwrite.0.8.0-preview.nupkg">
<IncludeInVSIX>true</IncludeInVSIX>
</Content>
<Content Include="Packages\microsoft.projectreunion.foundation.0.5.7.nupkg">
<Content Include="Packages\microsoft.projectreunion.foundation.0.8.0-preview.nupkg">
<IncludeInVSIX>true</IncludeInVSIX>
</Content>
<Content Include="Packages\microsoft.projectreunion.winui.0.5.7.nupkg">
<Content Include="Packages\microsoft.projectreunion.winui.0.8.0-preview.nupkg">
<IncludeInVSIX>true</IncludeInVSIX>
</Content>
<None Include="source.extension.vsixmanifest">
Expand Down Expand Up @@ -641,7 +641,7 @@
</ItemGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Build.Utilities.Core">
<Version>16.8.0</Version>
<Version>16.10.0</Version>
</PackageReference>
<PackageReference Include="Microsoft.TemplateEngine.Edge">
<Version>3.0.0-preview9.19381.3</Version>
Expand All @@ -658,7 +658,7 @@
<PrivateAssets>all</PrivateAssets>
</PackageReference>
<PackageReference Include="Microsoft.VSSDK.BuildTools">
<Version>16.8.3038</Version>
<Version>16.9.1050</Version>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
<PrivateAssets>all</PrivateAssets>
</PackageReference>
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
<WizardData>
<packages>
<package id="Microsoft.Windows.CppWinRT" version="2.0.210211.2" />
<package id="Microsoft.ProjectReunion" version="0.5.7" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.5.7" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.5.7" />
<package id="Microsoft.ProjectReunion" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.8.0-preview" />
</packages>
</WizardData>
</VSTemplate>
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
<WizardData>
<packages>
<package id="Microsoft.Windows.CppWinRT" version="2.0.210211.2" />
<package id="Microsoft.ProjectReunion" version="0.5.7" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.5.7" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.5.7" />
<package id="Microsoft.ProjectReunion" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.8.0-preview" />
</packages>
</WizardData>
</VSTemplate>
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
<WizardData>
<packages>
<package id="Microsoft.Windows.CppWinRT" version="2.0.210211.2" />
<package id="Microsoft.ProjectReunion" version="0.5.7" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.5.7" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.5.7" />
<package id="Microsoft.ProjectReunion" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.8.0-preview" />
</packages>
</WizardData>
</VSTemplate>
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
<WizardData>
<packages>
<package id="Microsoft.Windows.CppWinRT" version="2.0.210211.2" />
<package id="Microsoft.ProjectReunion" version="0.5.7" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.5.7" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.5.7" />
<package id="Microsoft.ProjectReunion" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.8.0-preview" />
</packages>
</WizardData>
</VSTemplate>
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
<WizardData>
<packages>
<package id="Microsoft.Windows.CppWinRT" version="2.0.210211.2" />
<package id="Microsoft.ProjectReunion" version="0.5.7" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.5.7" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.5.7" />
<package id="Microsoft.ProjectReunion" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.Foundation" version="0.8.0-preview" />
<package id="Microsoft.ProjectReunion.WinUI" version="0.8.0-preview" />
</packages>
</WizardData>
</VSTemplate>
Loading

0 comments on commit 96f1d4c

Please sign in to comment.