2.3 KiB
Contributing
Please read .NET Core Guidelines for more general information about coding styles, source structure, making pull requests, and more. While this project is in the early phases of development, some of the guidelines in this document -- such as API reviews -- do not yet apply as strongly. That said, please use open a GitHub to discuss first any API renames or changes before submitting PRs.
Developer guide
This project can be developed on any platform. To get started, follow instructions for your OS.
Prerequisites
This project depends on .NET Core 2.0. Before working on the project, check that .NET Core prerequisites have been met.
- Prerequisites for .NET Core on Windows
- Prerequisites for .NET Core on Linux
- Prerequisites for .NET Core on macOS
Visual Studio
This project supports Visual Studio 2017 and Visual Studio for Mac. Any version, including the free Community Edition, should be sufficient so long as you install Visual Studio support for .NET Core development.
This project also supports using Visual Studio Code. Install the C# extension and install the .NET Core CLI to get started.
Command line scripts
This project can be built on the command line using the build.cmd/build.sh scripts.
Run .\build.cmd -help or ./build.sh --help to see more options.
Compile
Windows:
> .\build.cmd
macOS/Linux
$ ./build.sh
Note: If you see the error NETSDK1031 when running the build script, make sure you specify a runtime ID by adding /p:RID={ id } (for example, /p:RID=win-x86) as a command line argument.
Running tests
To build and run tests:
Windows:
> .\build.cmd -test
macOS/Linux:
$ ./build.sh --test
To run tests without compiling,
Windows:
> .\test.cmd
macOS/Linux
$ ./test.sh