How to contribute¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can report bugs at https://github.com/zfit/zfit/issues.
Ready to contribute? Here’s how to set up zfit for local development.
Fork the zfit repo on GitHub.
Clone your fork locally:
$ git clone email@example.com:your_name_here/zfit.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv zfit $ cd zfit/ $ pip install -e .[alldev] # (or [dev] if this fails)
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass the tests (this can take a while ~30 mins):
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website. The test suite is going to run again, testing all the necessary Python versions.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
The pull request should include tests.
If the pull request adds functionality, the docs may need to be updated. Put your new functionality into a function with a docstring (and add the necessary explanations in the corresponding rst file in the docs). If any math is involved, please document the exact formulae implemented in the docstring/docs.
The pull request should work for all Python versions. Check https://travis-ci.org/zfit/zfit/pull_requests and make sure that the tests pass for all supported Python versions.