Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 1.15 KB

Contributing to the wps-pipeline-notebook

Please feel free to contribute to modelprop. You can fork it and adopt it as you need, but we would like to have also extensions flowing back into the original code base.

Version schema

We use a version schema that is just date oriented.

Branching policy

We use a development branch for every feature that we add. Master branch should just be used for a) the initial version b) the place to merge feature branches into.

(As this code is written initially by a single person, most of the stuff is done actually within the master branch).

Testing

We use unittests. Please make sure at least, that you write tests for the code you add or change.

Code styling

For code styling we use pep8 and pylint3. Make sure that your code is at least compliant with pep8.

There is no need to care about pylint3 warnings regarding to too less public methods in classes. Those are a good indicator to use functions / partitial functions instead, but using classes is clearer in most cases.

Also we don't care about unused arguments once methods implement a common protocol and those variables are used in other implementations.