Skip to content
This repository has been archived by the owner on Sep 17, 2023. It is now read-only.

How to Contribute

Daniel Wertheim edited this page Nov 10, 2015 · 9 revisions

Are you missing a feature or just want to help out? To maximize the chances of getting your pull-request accepted, please take a moment to read this guide on how to contribute.

Setting things up

1) Fork the project and add an upstream. More info.

2) Create a feature, fix, whatever branch from the master branch: git checkout -b my-feature-branch master

3) No NuGet packages are checked in. If you are using the latest version of NuGet (v2.7.1+) you should be able to just build and the packages will be restored.

4) Tests (both unit tests and integration tests) are written using xUnit with Fluent Assertions for assertions.

Work, work, work...

  • Please, try to keep your changes small and focused. Small commits are preferred.
  • Write proper commit messages! Commit messages should be helpful to others.
  • Do your work in the open. Share your ideas with the community as early as possible.

Before sending the pull request

1) Pull in changes to your branch from the official repository.

git checkout master
git pull upstream/master

2) Rebase your feature branch against develop.

git checkout my-feature-branch
git rebase master

Pull request

Now you can do the pull request against the official repo. Read more about pull-requests here.