@@ -44,14 +44,14 @@ For regular contributors: **Clone** the [repository](https://github.com/optimagi
4444 local optimagic repository:
4545
4646 ``` console
47- $ pre-commit install
47+ $ prek install
4848 ```
4949
5050 This activates pre-commit hooks for linting and style formatting.
5151
5252 ``` {note}
53- `pre-commit ` is not managed by pixi and must be installed globally. We recommend
54- installing it globally using pixi or uv .
53+ `prek ` is not managed by pixi and must be installed globally. You can find
54+ installation instructions at [github.com/j178/prek](https://github.com/j178/prek) .
5555 ```
5656
5757 You can then run the test suite with:
@@ -60,8 +60,14 @@ For regular contributors: **Clone** the [repository](https://github.com/optimagi
6060 $ pixi run tests
6161 ```
6262
63- which installs the development dependencies and runs pytest. To see all available
64- pixi tasks, run:
63+ which installs the development dependencies and runs pytest. To run the type checker,
64+ use:
65+
66+ ``` console
67+ $ pixi run mypy
68+ ```
69+
70+ To see all available pixi tasks, run:
6571
6672 ``` console
6773 $ pixi task list
@@ -84,8 +90,8 @@ For regular contributors: **Clone** the [repository](https://github.com/optimagi
8490 You can also run the test suite locally for
8591 [ debugging] ( https://effective-programming-practices.vercel.app/debugging/pdbp/objectives_materials.html ) .
8692
87- With pre-commit installed, linters run before each commit. Commits are rejected if
88- any checks fail. Note that some linters may automatically fix errors by modifying the
93+ With prek installed, linters run before each commit. Commits are rejected if any
94+ checks fail. Note that some linters may automatically fix errors by modifying the
8995 code in-place. Remember to re-stage the files after such modifications.
9096
9197``` {tip}
@@ -103,9 +109,9 @@ Skip the next paragraph if you haven't worked on the documentation.
103109 ` docs/build/html/index.html ` or any other file. Similar to the online documentation,
104110 you can navigate to different pages simply by clicking on the links.
105111
106- 1 . Once all tests and pre-commit hooks pass locally, push your changes to your forked
107- repository and create a pull request through GitHub: Go to the Github repository of
108- your fork. A banner on your fork's GitHub repository will prompt you to open a PR.
112+ 1 . Once all tests and hooks pass locally, push your changes to your forked repository
113+ and create a pull request through GitHub: Go to the Github repository of your fork. A
114+ banner on your fork's GitHub repository will prompt you to open a PR.
109115
110116 ``` {note}
111117 Regular contributors with push access can directly push their local branch to the remote optimagic repository and initiate a PR from there.
0 commit comments