Skip to content

Latest commit

 

History

History
22 lines (16 loc) · 726 Bytes

CONTRIBUTING.md

File metadata and controls

22 lines (16 loc) · 726 Bytes

Developing

  • Pull the repo
  • (optional) Create a virtual env and activate it
virtualenv ./venv
source ./venv/bin/activate
  • Install glib sudo apt-get install libglib2.0-dev
  • Install dependencies pip install bluepy webcolors
  • Run magicblueshell with sudo ./venv/bin/python3 magicblue/magicblueshell.py

Important

  • Make your pull requests against staging branch.

Optional but nice

  • Comment the issue or open a new one to let people know you're working on it
  • I try to follow PEP8 conventions but that's not a requirement for contributing.

You can check your code by installing tox with pip install tox then running tox in magicblue root folder.