Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1021 Bytes

CONTRIBUTING.md

File metadata and controls

26 lines (17 loc) · 1021 Bytes

The basics

Your help is appreciated and welcome!

The master branch is meant to hold the release code. At any time is should be identical to the code available on PyPI.

PR's will be pushed on the development branch if the actual package code is changed. When the time comes this branch will be merged to the master branch and a new release will be issued.

PR's that deal with documentation, and other addiacent files (README for example) can be pushed to the master branch.

When submitting PR's please take into account:

  • the project's gloals
  • PEP8 and the style guide bellow

Testing

Travis CI is enabled for this project. It is really helpfull for quality assurance and Python 2 and 3 compatibility check. It is advside to run the tests on both Python 3 and 2 before pushing the PR (Python 3.6 64 bit and Python 2.7 32 bit would be a very good combination to test).

Style guide

Just run black before sending the PR. There is no need to reinvent the wheel here!