Skip to content

Commit 4106914

Browse files
committed
Apply manual edits to the how-to-contribute guide
1 parent 3c5720e commit 4106914

1 file changed

Lines changed: 14 additions & 19 deletions

File tree

docs/source/development/how_to_contribute.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ contribution process (see Notes below).
3737
For regular contributors: **Clone** the [repository](https://github.com/optimagic-dev/optimagic/) to your local machine and create a new branch for implementing your changes. You can push your branch directly to the remote optimagic repository and open a PR from there.
3838
```
3939

40-
2. Clone your forked repository to your disk. This is where you'll make all your
40+
1. Clone your forked repository to your disk. This is where you'll make all your
4141
changes.
4242

4343
1. Open your terminal and execute the following commands from the root directory of your
@@ -54,16 +54,17 @@ For regular contributors: **Clone** the [repository](https://github.com/optimagi
5454
installing it globally using pixi or uv.
5555
```
5656

57-
To see all available pixi tasks, run:
57+
You can then run the test suite with:
5858

5959
```console
60-
$ pixi task list
60+
$ pixi run tests
6161
```
6262

63-
You can then run the test suite with:
63+
which installs the development dependencies and runs pytest. To see all available
64+
pixi tasks, run:
6465

6566
```console
66-
$ pixi run tests
67+
$ pixi task list
6768
```
6869

6970
1. Implement your fix or feature. Use git to add, commit, and push your changes to the
@@ -74,18 +75,14 @@ For regular contributors: **Clone** the [repository](https://github.com/optimagi
7475
1. Contributions are validated in two main ways. We run a comprehensive test suite to
7576
ensure compatibility with the existing codebase and employ
7677
[pre-commit hooks](https://effective-programming-practices.vercel.app/git/pre_commits/objectives_materials.html)
77-
to maintain quality and adherence to our style guidelines. Opening a PR (see
78-
paragraph 7 below) triggers optimagic's
78+
to maintain quality and adherence to our style guidelines. Opening a PR (see below)
79+
triggers optimagic's
7980
[Continuous Integration (CI)](https://docs.github.com/en/actions/automating-builds-and-tests/about-continuous-integration)
80-
workflow, which runs the full `pytest` suite, pre-commit hooks, and other checks on a
81+
workflow, which runs the full test suite, pre-commit hooks, and other checks on a
8182
remote server.
8283

8384
You can also run the test suite locally for
84-
[debugging](https://effective-programming-practices.vercel.app/debugging/pdbp/objectives_materials.html):
85-
86-
```console
87-
$ pytest
88-
```
85+
[debugging](https://effective-programming-practices.vercel.app/debugging/pdbp/objectives_materials.html).
8986

9087
With pre-commit installed, linters run before each commit. Commits are rejected if
9188
any checks fail. Note that some linters may automatically fix errors by modifying the
@@ -95,18 +92,16 @@ For regular contributors: **Clone** the [repository](https://github.com/optimagi
9592
Skip the next paragraph if you haven't worked on the documentation.
9693
```
9794

98-
6. Assuming you have updated the documentation, verify that it builds correctly. From
99-
the root directory of your local optimagic repo, navigate to the docs folder and set
100-
up the optimagic-docs environment:
95+
1. Assuming you have updated the documentation, verify that it builds correctly. Run:
10196

10297
```console
10398
$ pixi run build-docs
10499
```
105100

106-
This command builds the HTML documentation, saving all files in the `build/html`
101+
This command builds the HTML documentation, saving all files in the `docs/build/html`
107102
directory. You can view the documentation with your preferred web browser by opening
108-
`build/html/index.html` or any other file. Similar to the online documentation, you
109-
can navigate to different pages simply by clicking on the links.
103+
`docs/build/html/index.html` or any other file. Similar to the online documentation,
104+
you can navigate to different pages simply by clicking on the links.
110105

111106
1. Once all tests and pre-commit hooks pass locally, push your changes to your forked
112107
repository and create a pull request through GitHub: Go to the Github repository of

0 commit comments

Comments
 (0)