Skip to content

Commit

Permalink
[Documentation] - Updates to CONTRIBUTING (#55)
Browse files Browse the repository at this point in the history
Updates to CONTRIBUTING.md

## Description
- removed poetry references
- updated make command to run tests

## Related Issue
#53
  • Loading branch information
riccamini authored Sep 2, 2024
1 parent 5b6f9e1 commit 5819ed9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ if it isn't showing any activity.
We use `make` for managing different steps of setup and maintenance in the project. You can install make by following
the instructions [here](https://formulae.brew.sh/formula/make)

We use `poetry` as our package manager.
We use `hatch` as our package manager.

Please DO NOT use pip or conda to install the dependencies. Instead, use poetry:
Please DO NOT use pip or conda to install the dependencies. To install hatch (if on MAC):

```bash
make poetry-install
make init hatch-install
```

### 📌 Dev Environment Setup
Expand All @@ -75,7 +75,7 @@ Make sure that the linter does not report any errors or warnings before submitti
We use `pytest` to test our code. You can run the tests by running the following command:

```bash
make test
make dev-test
```

Make sure that all tests pass before submitting a pull request.
Expand Down

0 comments on commit 5819ed9

Please sign in to comment.