diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d86e08627..e04bceb39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -162,7 +162,7 @@ Before starting your work on the project, set up your development environment: 4. Install project dependencies: ```bash - uv pip install -r pyproject.toml --extra dev --extra docs --extra metrics + uv pip install -r pyproject.toml --group dev --group docs --extra metrics ``` 5. Run pytest to verify the setup: @@ -181,7 +181,7 @@ Furthermore, we have integrated a pre-commit GitHub Action into our workflow. Th To run the pre-commit tool, follow these steps: -1. Install pre-commit by running the following command: `uv pip install -r pyproject.toml --extra dev`. It will not only install pre-commit but also install all the deps and dev-deps of project +1. Install pre-commit by running the following command: `uv pip install -r pyproject.toml --group dev`. It will not only install pre-commit but also install all the deps and dev-deps of project 2. Once pre-commit is installed, navigate to the project's root directory. @@ -203,7 +203,7 @@ So far, **there is no type checking with mypy**. See [issue](https://github.com/ The `supervision` documentation is stored in a folder called `docs`. The project documentation is built using `mkdocs`. -To run the documentation, install the project requirements with `uv pip install -r pyproject.toml --extra dev --extra docs`. Then, run `mkdocs serve` to start the documentation server. +To run the documentation, install the project requirements with `uv pip install -r pyproject.toml --group dev --group docs`. Then, run `mkdocs serve` to start the documentation server. You can learn more about mkdocs on the [mkdocs website](https://www.mkdocs.org/).