Skip to content

Commit

Permalink
Add CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NiclasvanEyk committed Apr 4, 2024
1 parent 5b97aeb commit 2af34ea
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
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.

0 comments on commit 2af34ea

Please sign in to comment.