Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

63 lines (42 loc) · 3.3 KB

Contributing

We welcome contributions to our code, and will always endeavor to respond in a quick and helpful manner to Pull Requests.

  1. Please sign one of the contributor license agreements below (simple and pain-free).
  2. Fork the repo, develop and test your code changes, add docs.
  3. A Pull Request should be a set of changes that addresses one issue in the issue tracker. Please file one Pull Request per issue, and address one issue per Pull Request. If you want to make a change that doesn't have a corresponding issue in the issue tracker, please submit a new issue first.
  4. Make sure that your commit messages clearly describe the changes.
  5. Send a pull request.

Contributor License Agreements

Before we can accept your pull requests you'll need to sign a Contributor License Agreement (CLA):

  • If you are an individual writing original source code and you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

You can sign these electronically (just scroll to the bottom). After that, we'll be able to accept your pull requests.

Code Layout

These libraries are split into:

Building and .NET Core

We use Visual Studio 2015 to edit the Support Libraries.

MSBuild is currently used to run the Client Generator, and to build both the generated Client Libraries and the Support Libraries.

We are gradually transitioning towards using dotnet cli for testing and building (see #822). Until this is complete there are both csproj and project.json projects for all support libraries.

Tests

Support Library tests use NUnit.

Tests for the .NET45 platform are run using run_tests.bat, or can be run directly from within Visual Studio. Tests for .NET Core are run using run_tests_dotnetcore.bat (Windows) or run_tests_dotnetcore.sh (Linux).