Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

28 lines (16 loc) · 2.32 KB
Raw

Contributing

If you are looking for ways to contribute, please check out our task board or our open issues!

Issue Assignment

If you see an interesting issue, please feel free to comment or ask questions! Issues are generally resolved by code changes to our repository via a pull request. If you would like to be the one responsible for the code changes corresponding to an issue, and if nobody else has already been assigned to the issue, you can be assigned the issue by asking the issue creator or one of the moderators of repository, or by self-assigning the issue by commenting with /take.

Unit testing

When working on a particular issue, please also include relevant unit tests together with the code. Please see the following for example tests: example 1 example 2.

Creating a Pull Request

In order to contribute code to this repository, you must make a pull request (PR).

First, make sure you have a GitHub account and have git installed locally. Then, to make your first pull request,

  1. Fork our repository by clicking on the fork button on the repository's main page.
  2. Clone your fork.
  3. Create a new branch.
  4. Make your code contributions on this new branch.
  5. Create a PR from your fork to our repository.

(For subsequent pull requests, skip steps 1 and 2 and start directly from step 3.)

Once your pull request has been discussed, potentially updated, and approved, it will be merged by one of the project leads. If you have reached this step, congratulations and thank you for contributing!