-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5b97aeb
commit 2af34ea
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Contributing | ||
|
||
## Setup | ||
|
||
The project uses [Rye](https://rye-up.com), but feel free to install or setup the required packages using plain `pip` or whatever you prefer. | ||
|
||
Install the dependencies using | ||
|
||
```shell | ||
rye sync | ||
``` | ||
|
||
and run the tests using | ||
|
||
```shell | ||
pytest | ||
``` | ||
|
||
The project also uses `ruff` as a linter and formatter, so you may use | ||
|
||
```shell | ||
ruff check | ||
``` | ||
|
||
to run automated checks and | ||
|
||
```shell | ||
ruff format | ||
``` | ||
|
||
to automatically format your code. | ||
Both of these steps will run automatically in GitHub actions on every PR. | ||
|