@@ -116,30 +116,35 @@ Pre-commit for basic code quality checks
116116------------------------------------------
117117
118118We started using the `pre-commit <https://pre-commit.com/ >`_ tool
119- for basic code quality fine-tuning of new contributions.
120- Note that the whole repository does not adhere yet to these new code styles rules at the moment,
121- we're just gradually introducing it, piggybacking on new contributions and commits.
119+ for basic fine-tuning of code style and quality in new contributions.
122120It's currently not enforced, but **enabling pre-commit is recommended ** and appreciated
123121when contributing code.
124122
123+ .. note ::
124+
125+ Note that the whole repository does not fully follow all code styles rules at the moment.
126+ We're just gradually introducing it, piggybacking on new contributions and commits.
127+
128+
125129Pre-commit set up
126130""""""""""""""""""
127131
128- - Install the ``pre-commit `` command line tool:
132+ - Install the general ``pre-commit `` command line tool:
129133
130134 - The simplest option is to install it directly in the *virtual environment *
131135 you are using for openEO Python client development (e.g. ``pip install pre-commit ``).
132136 - You can also install it *globally * on your system
133137 (e.g. using `pipx <https://pypa.github.io/pipx/ >`_, conda, homebrew, ...)
134138 so you can use it across different projects.
135- - Install the git hook scripts by running this in your local git clone:
139+
140+ - Install the project specific git hook scripts by running this in the root of your local git clone:
136141
137142 .. code-block :: console
138143
139144 pre-commit install
140145
141- This will automatically install additional tools in a sandbox
142- to run the various checks defined in the ``.pre-commit-config.yaml `` configuration file.
146+ This will automatically install additional scripts and tools in a sandbox
147+ to run the various checks defined in the project's ``.pre-commit-config.yaml `` configuration file.
143148
144149Pre-commit usage
145150"""""""""""""""""
0 commit comments