Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

32 lines (19 loc) · 1.97 KB
Raw

Contributing

Thank you for considering contributing to this project! This document will outline how to submit changes to this repository and which conventions to follow.

Prerequisites

  • You're familiar with GitHub Issues and Pull Requests

Issues before PRs

  1. Before you start working on a change please make sure that there is an issue for what you will be working on. You can either find and existing issue or open a new issue if none exists. Doing this makes sure that others can contribute with thoughts or suggest alternatives, ultimately making sure that we only add changes that make

  2. When you are ready to start working on a change you should first fork this repo and create a new branch.

  3. Make your changes.

  4. Open a pull request. Your PR will soon be reviewed and approved.

Commits

Strive towards keeping your commits small and isolated - this helps the reviewer understand what is going on and makes it easier to process your requests.

Pull Requests

In your PR's description you should follow the structure:

  • What - what changes are in this PR
  • Why - why are these changes relevant
  • How - how have the changes been implemented
  • Testing - how has the changes been tested or how can the reviewer test the feature

Please add screenshots wherever necessary.

It is highly encouraged that you do a self-review prior to requesting a review. To do a self review click the review button in the top right corner, go through your code and annotate your changes. This makes it easier for the reviewer to process your PR.