Skip to content

Latest commit

 

History

History
21 lines (12 loc) · 696 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (12 loc) · 696 Bytes

Contributing to Better Thermostat

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to Better Thermostat. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

Reporting Bugs

You can create an issue if you have any kind of bug or error but please use the issue template.

Docstring type

We use numpy type docstrings. Documentation can be found here:

https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html

Setup

Install the pip install pre-commit used for pre-commit hooks.