Contributing

Kindly open an issue first to discuss the changes that you wish to make to Melissa before starting to work on any feature to avoid redundancy of work. Please create new branches when working on PRs to avoid branch conflicts by the time you finish working on your PR. Kindly rebase all your commits to one after approval to maintain the policy of a single commit per PR. Your PR must pass all the Travis CI checks and tests. After testing the PR manually, your changes will be merged into the main codebase.

Happy hacking, may the source be with you!

Testing

• To test the program, make sure you have virtual environment activated. Follow this guide to install virtual enviroment for python. Here are example which will be used here:

mkvirtual melissa_p2

• Install package listed on requirements-dev.txt:

pip install -r requirements-dev.txt

• Run pytest :

python -m pytest

Pytest guide can be found here.

• Before you push your commit, don't forget to run flake8 check.

python -m flake8