Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

24 lines (21 loc) · 1.63 KB

How to contribute

So you want to write code and get it landed in my Github Repo and want to help Data Scientists? Then first fork our repository into your own Github account, and create a local clone of it! The latter will be used to get new features implemented or bugs fixed. Once done and you have the code locally on the disk, you can get started. We advice to not work directly on the master branch, but to create a separate branch for each issue you are working on. That way you can easily switch between different work, and you can update each one for latest changes on upstream master individually. Check also our best practices for Git.

Writing Code

For writing the code just follow Python style guide, and also test with pylama. If there is something unclear of the style, just look at existing code which might help you to understand it better.

Submitting Patches

When you think the code is ready for review a pull request should be created on Github. I shall watch out for new PR‘s and review them in regular intervals. By default for each change in the PR we automatically run all the tests. If tests are failing make sure to address the failures immediately. Otherwise you can wait for a review. If comments have been given in a review, they have to get integrated. For those changes a separate commit should be created and pushed to your remote development branch. Don’t forget to add a comment in the PR afterward, so everyone gets notified by Github. Keep in mind that reviews can span multiple cycles until the owners are happy with the new code.

Merging Pull Requests

Once, I've reviewed the code, I'll hopefully merge it!