@@ -26,23 +26,23 @@ done via merge commits.
26
26
When starting to work on some issue
27
27
-----------------------------------
28
28
29
- When starting to work on some Github issue, please assign yourself to
29
+ When starting to work on some GitHub issue, please assign yourself to
30
30
let other developers know that you are working on it to avoid duplicate
31
31
work. If the respective issue is not completely clear, it is generally a
32
32
good idea to ask for clarification before starting to work on it.
33
33
34
- If you want to work on something new, please create a Github issue
35
- first.
34
+ If you want to work on something new, please create a
35
+ ` GitHub issue < https://github.com/AMICI-dev/AMICI/issues >`__ first.
36
36
37
37
Code contributions
38
38
------------------
39
39
40
40
When making code contributions, please follow our style guide and the
41
41
process described below:
42
42
43
- - Check if you agree to release your contribution under the conditions
44
- provided in `` LICENSE ``. By opening a pull requests you confirm us
45
- that you do agree.
43
+ - Check if you agree to release your contribution under
44
+ ` AMICI's license conditions < https://github.com/AMICI-dev/AMICI/blob/master/ LICENSE.md >`__.
45
+ By opening a pull requests you confirm us that you do agree.
46
46
47
47
- Start a new branch from ``develop `` (on your fork, or at the main
48
48
repository if you have access)
@@ -99,10 +99,10 @@ Python
99
99
- For the Python code we want to follow
100
100
`PEP8 <https://www.python.org/dev/peps/pep-0008/ >`__. Although this
101
101
is not the case for all existing code, any new contributions should
102
- do so. We use `black <https://black.readthedocs.io/en/stable/index.html >`__
103
- for code formatting.
102
+ do so. We use `ruff <https://docs.astral.sh/ruff/ >`__ for automated
103
+ code formatting.
104
104
105
- To run black as pre-commit hook, install the
105
+ To run ruff as pre-commit hook, install the
106
106
`pre-commit <https://pre-commit.com/ >`_ package
107
107
(e.g. ``pip install pre-commit ``), and enable AMICI-hooks by running
108
108
``pre-commit install `` from within the AMICI directory.
0 commit comments