From 5819ed959492d3ea175d10849baedae6ff9d8400 Mon Sep 17 00:00:00 2001 From: Riccardo Iacomini Date: Mon, 2 Sep 2024 10:41:12 +0200 Subject: [PATCH] [Documentation] - Updates to CONTRIBUTING (#55) Updates to CONTRIBUTING.md ## Description - removed poetry references - updated make command to run tests ## Related Issue https://github.com/Nike-Inc/koheesio/issues/53 --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0145c92..65a8dc0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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.