Skip to content

Commit 03901fc

Browse files
authored
Update contribution guide (#2668)
Update contribution guide
1 parent b8ae3e4 commit 03901fc

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/development.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,23 @@ done via merge commits.
2626
When starting to work on some issue
2727
-----------------------------------
2828

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
3030
let other developers know that you are working on it to avoid duplicate
3131
work. If the respective issue is not completely clear, it is generally a
3232
good idea to ask for clarification before starting to work on it.
3333

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.
3636

3737
Code contributions
3838
------------------
3939

4040
When making code contributions, please follow our style guide and the
4141
process described below:
4242

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.
4646

4747
- Start a new branch from ``develop`` (on your fork, or at the main
4848
repository if you have access)
@@ -99,10 +99,10 @@ Python
9999
- For the Python code we want to follow
100100
`PEP8 <https://www.python.org/dev/peps/pep-0008/>`__. Although this
101101
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.
104104

105-
To run black as pre-commit hook, install the
105+
To run ruff as pre-commit hook, install the
106106
`pre-commit <https://pre-commit.com/>`_ package
107107
(e.g. ``pip install pre-commit``), and enable AMICI-hooks by running
108108
``pre-commit install`` from within the AMICI directory.

0 commit comments

Comments
 (0)