Skip to content

Commit 1452741

Browse files
committed
🖊️ update CONTRIBUTING.md
1 parent 8755516 commit 1452741

File tree

2 files changed

+21
-2
lines changed

2 files changed

+21
-2
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
venv*
22
.cache_datasets/
3+
*.ruff*
34
*.DS_Store
45
file_system_store/
56

CONTRIBUTING.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,30 @@ poetry build # build the underlying C code
7979

8080
</details>
8181

82+
### Formatting the code
83+
84+
We use [black](https://github.com/psf/black) and [isort](https://github.com/PyCQA/isort) to format the code.
85+
86+
To format the code, run the following command (more details in the [Makefile](Makefile)):
87+
```sh
88+
make format
89+
```
90+
91+
### Checking the linting
92+
93+
We use [ruff](https://github.com/charliermarsh/ruff) to check the linting.
94+
95+
To check the linting, run the following command (more details in the [Makefile](Makefile)):
96+
```sh
97+
make lint
98+
```
99+
82100
### Running the tests (& code coverage)
83101

84-
You can run the test with the following code:
102+
You can run the tests with the following code (more details in the [Makefile](Makefile)):
85103

86104
```sh
87-
poetry run pytest --cov-report term-missing --cov=plotly_resampler tests
105+
make test
88106
```
89107

90108
To get the selenium tests working you should have Google Chrome installed.

0 commit comments

Comments
 (0)