Skip to content

Commit

Permalink
* Changed new version number from 3.0 to 2.1
Browse files Browse the repository at this point in the history
* Added a section about creating a new test
* Link to test documentation from contribution workflow
* Fix various wrapping issues
  • Loading branch information
UXP Controls Automated Porting System committed Dec 13, 2018
1 parent 6261864 commit dc375ec
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 15 deletions.
4 changes: 2 additions & 2 deletions docs/contribution_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ have one).
4. Make and commit your changes.
* Please follow our [Commit Messages](contribution_workflow.md#Commit%20Messages)
guidance.
5. Add new tests corresponding to your change, if applicable.
5. Add [new tests](developer_guide.md#Testing) corresponding to your change, if applicable.
6. Build the repository with your changes.
* Make sure that the builds are clean.
* Make sure that the tests are all passing, including your new tests.
* Make sure that the [tests](developer_guide.md#Testing) are all passing, including your new tests.
7. Create a pull request (PR) against the upstream repository's master branch.
* Push your changes to your fork on GitHub (if you haven't already).
- Note: It is okay for your PR to include a large number of commits. Once
Expand Down
45 changes: 36 additions & 9 deletions docs/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ that contains all the controls and other solutions which will be packaged and
deployed. At this time we believe the Microsoft.UI.Xaml.dll is
small enough to include all controls into one DLL. As we increase the number of
controls we will revisit this decision and may decompose it into different DLLs
in the future. Also we will adjust based on developer feedback if we start to see
usage patterns where teams use just a few controls vs. the whole library.
in the future. Also we will adjust based on developer feedback if we start to see
usage patterns where teams use just a few controls vs. the whole library.

This project also includes the necessary definitions to package the DLL into a
NuGet package.
Expand All @@ -64,7 +64,9 @@ by automating the MUXControlsTestApp.

MUXControlsTestApp is a UWP app that exercises all the controls. This is just a
manual testing playground which can be driven by the automated tests for
automated verification as well as [TestMethod] control API verification. Note this applications references the MUXControls DLL rather than including the Shared Items.
automated verification as well as [TestMethod] control API verification. Note
this applications references the MUXControls DLL rather than including the
Shared Items.

## Code style and conventions

Expand Down Expand Up @@ -173,7 +175,9 @@ build and run MUXControl.ReleaseTest.
One of the core values of WinUI is the way that it brings controls to a wide
variety of versions of Windows, handling version compatibility differences so
that developers using WinUI don't have to. As such, testing WinUI changes on
different versions is sometimes necessary. To accomplish this you will need to at times set up older versions of Windows for testing. To get these earlier versions you can make use of a Visual Studio subscription [as described here](https://docs.microsoft.com/azure/virtual-machines/windows/client-images).
different versions is sometimes necessary. To accomplish this you will need to
at times set up older versions of Windows for testing. To get these earlier
versions you can make use of a Visual Studio subscription [as described here](https://docs.microsoft.com/azure/virtual-machines/windows/client-images).

### Automated testing

Expand All @@ -184,19 +188,42 @@ level menu. For targeting indivual tests you can use [Test Explorer](https://doc
This same suite of tests will be run as part of your Pull Request validation
[check](contribution_workflow.md#Checks).

#### Creating a new test

For your test to be discovered it needs to be a method tagged as [\[TestMethod\]](https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualstudio.testtools.unittesting.testmethodattribute?view=mstest-net-1.2.0)
on a class tagged with as [\[TestClass\]](https://docs.microsoft.com/en-us/dotnet/api/microsoft.visualstudio.testtools.unittesting.testclassattribute?view=mstest-net-1.2.0).
With that metadata in place your new test method will be picked up by Test
Explorer.

There are two types of tests you can use to validate your scenarios:
* **API Tests**: Run in the context of an app and validate the behaviors of our
APIs.
* **Interaction Tests**: Drive the UI on an external app and validate the
results using UI Automation.

Keep in mind that your test will be executed on many different versions of
Windows, not just the most recent version. Your tests may need version or
[IsApiPresent](https://docs.microsoft.com/en-us/uwp/api/windows.foundation.metadata.apiinformation.istypepresent)
checks in order to pass on all versions.

## Telemetry

This project collects usage data and sends it to Microsoft to help improve our products and services.
This project collects usage data and sends it to Microsoft to help improve our
products and services.

If desired you can disable logging when building the project by following these steps:
If desired you can disable logging when building the project by following these
steps:

1. In Microsoft Visual Studio's Solution Explorer window, right-click the "Microsoft.UI.Xaml (Universal Windows)" project.
1. In Microsoft Visual Studio's Solution Explorer window, right-click the
"Microsoft.UI.Xaml (Universal Windows)" project.
2. Select the "Properties" menu.
3. Select "All Configurations" in the Configuration dropdown.
4. Select "All Platforms" in the Platform dropdown.
5. Select "Configuration Properties", then "C/C++", then "Preprocessor" in the left tree structure.
5. Select "Configuration Properties", then "C/C++", then "Preprocessor" in the
left tree structure.
6. In the entry called "Preprocessor Definitions":
* Add "DISABLE_TELEMETRY_TRACELOGGING;" to disable Microsoft telemetry logging alone.
* Add "DISABLE_TELEMETRY_TRACELOGGING;" to disable Microsoft telemetry
logging alone.
* Add "DISABLE_PERF_TRACELOGGING;" to disable performance logging alone.
* Add "DISABLE_DEBUG_TRACELOGGING;" to disable debug logging alone.
* Or simply add "DISABLE_ALL_TRACELOGGING;" to disable all three types of logging.
Expand Down
12 changes: 8 additions & 4 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ For 2018-2019 the WinUI team is focused on:

1. Establishing our open source development process on GitHub

2. Continuing to extend the [Fluent Design System](https://www.microsoft.com/design/fluent) for Windows apps
2. Continuing to extend the [Fluent Design System](https://www.microsoft.com/design/fluent)
for Windows apps

3. Continuing to migrate UWP Xaml platform controls to WinUI

Expand All @@ -20,17 +21,20 @@ For 2018-2019 the WinUI team is focused on:
* a new Tip control
* a new Ribbon control

We also welcome your code contributions, particularly if they fix bugs or add functionality that aligns with the above.
We also welcome your code contributions, particularly if they fix bugs or add
functionality that aligns with the above.
See the [contribution guide](../CONTRIBUTING.md) for more info on contributing.

## NuGet releases

WinUI is distributed as official Microsoft [NuGet packages](https://docs.microsoft.com/nuget/what-is-nuget) which are regularly built from this repo.
WinUI is distributed as official Microsoft [NuGet packages](https://docs.microsoft.com/nuget/what-is-nuget)
which are regularly built from this repo.

New **prerelease** NuGet packages are released approximately monthly.
New **stable** NuGet packages are released approximately twice a year.

The list of WinUI packages can be found here:
https://www.nuget.org/profiles/winui

The next stable release scheduled for the first half of 2019 will be called WinUI 3.0.
The next stable release scheduled for the first half of 2019 will be called
WinUI 2.1.

0 comments on commit dc375ec

Please sign in to comment.