Skip to content

Commit 6da65a2

Browse files
committed
Bit of finetuning of the development docs
- pre-commit clarifications - drop the (now outdated) recommendation to wait for a VITO jenkins build in release procedure
1 parent 88ad3ac commit 6da65a2

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

docs/development.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ for user contributions, which roughly follows these steps:
115115
Pre-commit for basic code quality checks
116116
------------------------------------------
117117

118-
We started using the `pre-commit <https://pre-commit.com/>`_ tool
118+
We started using the generic `pre-commit <https://pre-commit.com/>`_ tool
119119
for basic fine-tuning of code style and quality in new contributions.
120120
It's currently not enforced, but **enabling pre-commit is recommended** and appreciated
121121
when contributing code.
@@ -129,17 +129,20 @@ when contributing code.
129129
Pre-commit set up
130130
""""""""""""""""""
131131

132-
- Install the general ``pre-commit`` command line tool:
132+
1. Install the general ``pre-commit`` command line tool, for example:
133133

134134
- The simplest option is to install it directly in the *virtual environment*
135135
you are using for openEO Python client development (e.g. ``pip install pre-commit``).
136136
- You can also install it *globally* on your system
137137
(e.g. using `pipx <https://pipx.pypa.io/>`_,
138138
`uv tool <https://docs.astral.sh/uv/concepts/tools/>`_,
139139
conda, homebrew, ...)
140-
so you can use it across different projects.
140+
so you can easily (re)use it across different projects.
141141

142-
- Install the project specific git hook scripts by running this in the root of your local git clone:
142+
Or follow the official installation instructions at
143+
`https://pre-commit.com/#install <https://pre-commit.com/#install>`_.
144+
145+
2. Install the project-specific git hook scripts by running this in the root of your local git clone:
143146

144147
.. code-block:: console
145148
@@ -274,11 +277,6 @@ we will use a concrete version ``0.8.0`` in the examples below.
274277
git commit -m 'Release 0.8.0'
275278
git push origin master
276279

277-
#. Optional, but recommended: wait for **VITO Jenkins** to build this updated master
278-
(trigger it manually if necessary),
279-
so that a build of a final, non-alpha release ``0.8.0``
280-
is properly uploaded to **VITO artifactory**.
281-
282280
#. Create release on `PyPI <https://pypi.org/>`_:
283281

284282
A. **Obtain a wheel archive** of the package, with one of these approaches:

0 commit comments

Comments
 (0)