Skip to content

Latest commit

 

History

History
56 lines (40 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

56 lines (40 loc) · 3.24 KB
Raw

Contributing

All contributions made to this library must be under terms compatible with the license in the accompanying LICENSE file.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Best practices

  • Use Windows PowerShell or PowerShell Core (including on Linux/OSX) to run .ps1 scripts. Some scripts set environment variables to help you, but they are only retained if you use PowerShell as your shell.

Prerequisites

  1. SQL Server LocalDB. Manual installation required. This may already be included in your VS installation.

  2. Node.js for running Azurite. init.ps1 will not install this.

  3. Azurite or the Azure Storage Emulator. init.ps1 installs Azurite using npm.

  4. Azure Cosmos emulator.

  5. .NET Core SDK init.ps1 can install this.

    You should install the version specified in global.json or a later version within the same major.minor.Bxx "hundreds" band. For example if 2.2.300 is specified, you may install 2.2.300, 2.2.301, or 2.2.310 while the 2.2.400 version would not be considered compatible by .NET SDK. See .NET Core Versioning for more information.

All dependencies (other than Node.js) can be installed by running the init.ps1 script at the root of the repository using Windows PowerShell or PowerShell Core (on any OS). Some dependencies installed by init.ps1 may only be discoverable from the same command line environment the init script was run from due to environment variables, so be sure to launch Visual Studio or build the repo from that same environment. Alternatively, run init.ps1 -InstallLocality Machine (which may require elevation) in order to install dependencies at machine-wide locations so Visual Studio and builds work everywhere.

Package restore

The easiest way to restore packages may be to run init.ps1 which automatically authenticates to the feeds that packages for this repo come from, if any. dotnet restore and yarn manually may also be used.

Building

This repository can be built on Windows, Linux, and OSX.

Building, testing, and packing this repository can be done by using Visual Studio or the standard dotnet CLI commands (e.g. dotnet build, dotnet test, dotnet pack, etc.).

Testing

Our unit tests requires that Azurite (or the Azure Storage Emulator) be started first. After installing the emulator (see Prerequisites) it can be started from the Windows Start menu. Use the tools/Emulators.ps1 script to run the Azure emulators.