Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.63 KB
Raw

Contributing

How to contribute?

We appreciate and welcome community contributions.

  1. You must sign a Contributor License Agreement (CLA) before submitting your pull request. To complete the CLA, submit a request via the form and electronically sign the CLA when you receive the email containing the link to the document. You need to complete the CLA only once to cover all Microsoft Open Technologies OSS projects. To sign a CLA please follow the instructions on Microsoft CLA

  2. Before starting work on a new feature, enhancement or fix, please create an issue and optionally assign it to yourself or a developer.

  3. Fork the repository and make your changes against the fork just created (and not against master).

  4. After making your changes in your fork, run tests and ensure that the code runs well on all suported platforms. Ensure that your branch has no merge conflicts with master.

  5. Issue a Pull Request and make sure to fill out the information needed according to the Pull Request Template.

  6. The admins will review your code and may optionally request conformance, functional or other changes. Work with them to resolve any issues.

  7. Upon acceptance, your code will be merged into the master branch and will become available for all.

Building

PowerShell

Run PowerShell and execute build.ps1.

Bash

Run bash and execute build.sh.

Adding a project to build

Update build\build-order.txt to include the path to the folder of the project you want to build (relative to the root of the repo).

Running

Once you have built Nether, you can run it in a number of ways.

Visual Studio

To run from Visual Studio, open Nether.sln and click Start (Ctrl+F5, or F5 to run with the debugger).

Visual Studio Code

To run from Visual Studio Code, open the root of the repo in Visual Studio Code and click Start on the Debugger tab (F5, ot Ctrl+F5 to run without the debugger).

PowerShell

Run PowerShell and execute rundev.ps1.

Bash

Run bash and execute rundev.sh.

Coding style

This project uses the coding style from the dotnet/corefx repo.

The coding style (and C# license header) is enforced by the CodeFormatter tool when building a Pull Request. If you are running on Windows then you can run the tool locally to short-circuit the feedback loop. If you're on another platform then vote up the xplat issue :-)