Skip to content

Commit

Permalink
Add contributing information
Browse files Browse the repository at this point in the history
  • Loading branch information
skorokithakis committed Jul 9, 2018
1 parent c70b1ad commit 085bb0f
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,28 @@ Refer to the rest of `the documentation
<https://yeelight.readthedocs.io/en/stable/>`_ for more details.


Contributing
------------

If you'd like to contribute to the code, thank you! To install the various libraries
required, run (preferably in a virtualenv)::

$ pip install -Ur requirements_dev.txt

In order for your MR to pass CI, it needs to be checked by various utilities, which are
managed by `pre-commit`. `pre-commit` will be installed by the above command, but you
also need to install the pre-commit hook::

$ pre-commit install

The hook will run on commit. To run it manually (e.g. if you've already committed but
forgot to run it, just run)::

$ pre-commit run -a

Thanks again!


License
-------

Expand Down

0 comments on commit 085bb0f

Please sign in to comment.