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: CONTRIBUTING.md
+10-13Lines changed: 10 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ encouraged to modify the codebase with new fixes and enhancements. Please
31
31
observe the following guidelines when submitting pull requests for new fixes or
32
32
features:
33
33
34
-
1. All new code must be formatted with [ruff](https://github.com/astral-sh/ruff). The .vscode directory in this repository is configured to autoformat with ruff on save if you are using VSCode.
34
+
1. All new Python code must be formatted with [ruff](https://github.com/astral-sh/ruff). The .vscode directory in this repository is configured to autoformat with ruff on save if you are using VSCode. All Cython code must pass a check from [cython-lint](https://github.com/MarcoGorelli/cython-lint).
35
35
36
36
2. Whether you are introducing a bug fix or a new feature, you *must* add tests to verify that your code additions function correctly and break nothing else.
37
37
@@ -40,36 +40,33 @@ features:
40
40
4. If you are adding a new feature or changing behavior, please update the documentation appropriately with the relevant information. To run the documentation site locally, install the documentation dependencies with:
41
41
42
42
```sh
43
-
poetry install --with docs
43
+
pdm install -G docs --no-self
44
44
```
45
45
46
46
Then, start the local server with the following command:
47
47
48
48
```sh
49
-
poetry run mkdocs serve
49
+
pdm run mkdocs gh-deploy --force
50
50
```
51
-
### Using Poetry
51
+
### Using PDM
52
52
53
-
This project is developed using [poetry](https://python-poetry.org/). It is strongly recommended for local development.
53
+
This project is developed using [PDM](https://pdm-project.org). It is strongly recommended for local development.
54
54
55
55
### Installing project dependencies
56
56
57
-
To install the local version of the library with development dependencies, run the following:
57
+
To install the local version of the library with all development dependencies, run the following:
58
58
59
59
```sh
60
-
poetry install --with dev
60
+
pdm install -G :all --without docs
61
61
```
62
62
63
-
### Cython Generation
64
-
65
-
The Cython code for this project is generated and then committed to the repository. This code generation is not enabled by default. To enable this, add `"cython"` to the build dependencies in `pyproject.toml`.
66
-
Make sure not to commit this change, as it just enables regeneration
67
-
of the C++ files from Cython code.
63
+
This will build the project locally and install dependencies. To rebuild the project after making changes,
64
+
run `pdm install` again.
68
65
69
66
### Running unit tests
70
67
71
68
The unit tests use [pytest](https://docs.pytest.org/en/8.0.x/).
0 commit comments