This project is actively developed using the following software. It is highly recommended that anyone contributing to this library use the same software.
Some projects in the Visual Studio solution require optional or 3rd party components to open. They are not required to build the full solution from the command line using MSBuild, but installing this software will facilitate an enhanced developer experience in Visual Studio.
All other dependencies are acquired via NuGet or NPM.
To build this repository from the command line, you must first execute our init.ps1 script, which downloads NuGet.exe and uses it to restore packages. Assuming your working directory is the root directory of this git repo, and you are running Windows PowerShell, the command is:
.\init.ps1
Most of the repo may be built via building the solution file from Visual Studio 2017, but for a complete build, build from the VS2017 Developer Command Prompt:
.\build.ps1
This repo is structured such that it builds the NuGet package first, using MSBuild. It then builds an NPM package that includes some of the outputs of MSBuild, along with some javascript, for our NPM consumers who want a reasonable versioning story for their NPM packages too.
The Visual Studio 2017 Test Explorer will list and execute all tests.
Pull requests are welcome! They may contain additional test cases (e.g. to demonstrate a failure), and/or product changes (with bug fixes or features). All product changes should be accompanied by additional tests to cover and justify the product change unless the product change is strictly an efficiency improvement and no outwardly observable change is expected.
In the master branch, all tests should always pass. Added tests that fail should be marked as Skip
via [Fact(Skip = "Test does not pass yet")] or similar message to keep our test pass rate at 100%.