Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (26 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.17 KB

Contributing

We welcome contributions to this repository. In order to do so, please fork this repository and submit pull requests according to the section below.

Submitting a pull request

  1. Fork this repository
  2. Create a new branch from our dev branch, and give it a descriptive name
  3. Commit your work to this branch
  4. Submit a new PR

In this PR, please include the following information:

  • What did you change?
  • Why did you change it? (Please link to issues if available)
  • How did you implement the change?

These points help us review your PR.

Submitting an issue

Please feel free to submit new issues. You can use the search function on GitHub to check if an issue for the problem you are experiencing already exists. But if you cannot find an issue that matches your exact problem, please feel free to submit a new issue.

We use a number of templates for issues that you can use, but if your issue does not fit within the templates, please feel free to submit a custom issue.

Code guidelines

The codebase largely follows the PEP8 standards, and uses flake8 for linting. We use black for auto formatting. Please ensure you have run a formatting tool on your code.