Skip to content

Latest commit

 

History

History
28 lines (19 loc) · 848 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (19 loc) · 848 Bytes

Contributing to Honeycomb

Pull requests are welcome! Please make sure to follow coding style requirements and confirm all tests pass before opening a PR

Set up development environment

Make sure you have both python 2.7 and 3.6 available as they are required for testing

Install pyenv

curl -L https://raw.githubusercontent.com/pyenv/pyenv-installer/master/bin/pyenv-installer | bash

Follow instructions to init pyenv and add it to your bashrc/zshrc file

Install python 2 and 3

$ pyenv install 2.7.14
$ pyenv install 3.6.3
$ pyenv global 2.7.14 3.6.3

Set up virtualenv and install tox

$ virtualenv venv
$ source venv/bin/activate
$ pip install tox

Make sure tests are working

$ tox

This will run all the existing tests, do not start coding before you solve any local configuration issues