Contribute

You can help

Please open issues and feature requests on Github. We respond quickly.

  • Documentation. Tell us what’s missing, what’s incorrect or misleading.

  • Tests. If you have an example that shows a bug or problem, please file an issue!

  • Performance. If you are a C/cython/python hacker and see a way to make the code faster, let us know!

Direct contributions related to these items are welcome, too! If you want to contribute, please fork the project on Github, develop your change and then make a pull request. This allows us to review and discuss the change with you, which makes the integration very smooth.

Development setup

git

To hack on iminuit, start by cloning the repository from Github:

git clone --recursive https://github.com/scikit-hep/iminuit.git
cd iminuit

It is a good idea to develop your feature in a separate branch, so that your develop branch remains clean and can follow our develop branch.

git checkout -b my_cool_feature develop

Now you are in a feature branch, commit your edits here.

Development workflow

You have the source code now, but you also want to build and test. We recommend to use nox, which automatically creates a dedicated virtual environment for iminuit, separate from the Python installation you use for other projects.

nox -s test

This installs your version of iminuit locally and all the dependencies needed to run the tests, and then runs the tests.

Generate a coverage report:

nox -s cov
<your-web-browser> build/htmlcov/index.htm

Build the docs:

nox -s doc
<your-web-browser> build/html/index.html

Maintainers that prepare a release, should follow the instructions in doc/README.md

To check your iminuit version number and install location:

$ python
>>> import iminuit
>>> iminuit
# install location is printed
>>> iminuit.__version__
# version number is printed