Skip to content

Commit 0245944

Browse files
committed
Update CONTRIBUTING.md
1 parent d121ddc commit 0245944

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ encouraged to modify the codebase with new fixes and enhancements. Please
3131
observe the following guidelines when submitting pull requests for new fixes or
3232
features:
3333

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).
3535

3636
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.
3737

@@ -40,36 +40,33 @@ features:
4040
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:
4141

4242
```sh
43-
poetry install --with docs
43+
pdm install -G docs --no-self
4444
```
4545

4646
Then, start the local server with the following command:
4747

4848
```sh
49-
poetry run mkdocs serve
49+
pdm run mkdocs gh-deploy --force
5050
```
51-
### Using Poetry
51+
### Using PDM
5252

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.
5454

5555
### Installing project dependencies
5656

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:
5858

5959
```sh
60-
poetry install --with dev
60+
pdm install -G :all --without docs
6161
```
6262

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.
6865

6966
### Running unit tests
7067

7168
The unit tests use [pytest](https://docs.pytest.org/en/8.0.x/).
7269

7370
```sh
74-
poetry run pytest
71+
pdm run pytest
7572
```

0 commit comments

Comments
 (0)