You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/development/how_to_contribute.md
+14-19Lines changed: 14 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ contribution process (see Notes below).
37
37
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.
38
38
```
39
39
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
41
41
changes.
42
42
43
43
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
54
54
installing it globally using pixi or uv.
55
55
```
56
56
57
-
To see all available pixi tasks, run:
57
+
You can then run the test suite with:
58
58
59
59
```console
60
-
$ pixi task list
60
+
$ pixi run tests
61
61
```
62
62
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:
64
65
65
66
```console
66
-
$ pixi run tests
67
+
$ pixi task list
67
68
```
68
69
69
70
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
74
75
1. Contributions are validated in two main ways. We run a comprehensive test suite to
75
76
ensure compatibility with the existing codebase and employ
0 commit comments