How to contribute

Bug reports in the issue tracker and pull requests are welcome.

Pull request

Clone your fork.

git clone https://github.com/YOUR_GIT_USERNAME/pymysensors.git
cd pymysensors

Add the main repository as upstream.

git remote add upstream https://github.com/theolind/pymysensors.git

Create a feature branch based off master branch.
```
git checkout -b cool_new_feature master
```
Make your changes in the new topic branch. New features should preferably be accompanied with new tests. PEP8 and PEP257 style should be followed. We use pylint and flake8 as code linters.
Test with tox and make sure existing tests don't fail. Linting will also be checked when tox is run.
```
pip3 install -r requirements_dev.txt
tox
```
Add and commit your work and describe the additions and or changes in the commit message. Use an editor for the commit message, not the command line. Try to keep the header of the commit message within 50 characters and the body within 72 characters per line. A blank line should separate the header from the body of the commit message. Markdown is cool.
```
git add -A
git commit
```
Push you local changes to your fork.
```
git push origin HEAD
```
Create a pull request at github to the main pymysensors repository and target the master branch with your changes.
Watch build checks turn green ✅, and get the 👍 in the code review.