1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
.. include:: bibliography.txt
.. _contribute:
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 <https://help.github.com/articles/fork-a-repo>`_, develop your change and then make a `pull request <https://help.github.com/articles/creating-a-pull-request-from-a-fork>`_. 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`_:
.. code-block:: bash
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.
.. code-block:: bash
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.
.. code-block:: bash
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:
.. code-block:: bash
nox -s cov
<your-web-browser> build/htmlcov/index.htm
Build the docs:
.. code-block:: bash
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:
.. code-block:: bash
$ python
>>> import iminuit
>>> iminuit
# install location is printed
>>> iminuit.__version__
# version number is printed
.. _conda: https://conda.io/
.. _miniconda: https://conda.io/en/latest/miniconda.html
.. _Python virtual environments: http://docs.python-guide.org/en/latest/dev/virtualenvs/
.. _Github: https://github.com/scikit-hep/iminuit
.. _Makefile: https://github.com/scikit-hep/iminuit/blob/main/Makefile
|