Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Documentation] - Updates to CONTRIBUTING #55

Merged
merged 3 commits into from
Sep 2, 2024
Merged

[Documentation] - Updates to CONTRIBUTING #55

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
10f96d4
Removed references to poetry, updated make command to run tests
riccamini Jul 9, 2024
398482d
Merge branch 'main' into feature/update-contributing
dannymeijer Aug 27, 2024
323a835
Merge branch 'main' into feature/update-contributing
dannymeijer Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
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