From 351425b2948a0aae027e56ec574de594381ad472 Mon Sep 17 00:00:00 2001 From: Ayush kumar Date: Thu, 2 Oct 2025 15:15:47 +0530 Subject: [PATCH 1/2] Update CONTRIBUTING.md Updated type checking to include hints and mypy/pyright; refreshed links to latest docs, LICENSE, and cookbook examples. --- CONTRIBUTING.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d86e08627..d18791390 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,6 +23,7 @@ Please read and adhere to our [Code of Conduct](https://supervision.roboflow.com - [Tests](#tests) - [License](#license) + ## Contribution Guidelines We welcome contributions to: @@ -83,7 +84,7 @@ git push -u origin Use conventional commit messages to clearly describe your changes. The format is: -\[optional scope\]: +[optional scope]: Common types include: @@ -132,7 +133,7 @@ Before starting your work on the project, set up your development environment: **Option A: Recommended for most contributors (shallow clone of develop branch):** - ```bash + ```bash:disable-run git clone --depth 1 -b develop https://github.com/YOUR_USERNAME/supervision.git cd supervision ``` @@ -197,7 +198,7 @@ All new functions and classes in `supervision` should include docstrings. This i ### Type checking -So far, **there is no type checking with mypy**. See [issue](https://github.com/roboflow-ai/template-python/issues/4). +We use type hints throughout the codebase. Contributors are encouraged to use tools like mypy or pyright for static type checking. Run `mypy .` or `pyright .` to verify types. ## ๐Ÿ“ Documentation @@ -215,7 +216,7 @@ submit a PR with your example. Here are some guidelines for submitting a new exa - Create a new notebook in the [`docs/notebooks`](https://github.com/roboflow/supervision/tree/develop/docs/notebooks) folder. - Add a link to the new notebook in [`docs/theme/cookbooks.html`](https://github.com/roboflow/supervision/blob/develop/docs/theme/cookbooks.html). Make sure to add the path to the new notebook, as well as a title, labels, author and supervision version. -- Use the [Count Objects Crossing the Line](https://supervision.roboflow.com/develop/notebooks/count-objects-crossing-the-line/) example as a template for your new example. +- Use the [Count Objects Crossing the Line](https://supervision.roboflow.com/latest/notebooks/count-objects-crossing-the-line/) example as a template for your new example. - Freeze the version of `supervision` you are using. - Place an appropriate Open in Colab button at the top of the notebook. You can find an example of such a button in the aforementioned `Count Objects Crossing the Line` cookbook. - Notebook should be self-contained. If you rely on external data ( videos, images, etc.) or libraries, include download and installation commands in the notebook. @@ -223,8 +224,9 @@ submit a PR with your example. Here are some guidelines for submitting a new exa ## ๐Ÿงช Tests -[`pytests`](https://docs.pytest.org/en/7.1.x/) is used to run our tests. +[`pytest`](https://docs.pytest.org/en/stable/) is used to run our tests. ## ๐Ÿ“„ License -By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/roboflow/supervision/blob/develop/LICENSE.md). +By contributing, you agree that your contributions will be licensed under an [MIT license](https://github.com/roboflow/supervision/blob/main/LICENSE). +``` From fe524ee41bcb02894e76a143db662f05c1bf57c7 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 2 Oct 2025 09:50:29 +0000 Subject: [PATCH 2/2] =?UTF-8?q?fix(pre=5Fcommit):=20=F0=9F=8E=A8=20auto=20?= =?UTF-8?q?format=20pre-commit=20hooks?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d18791390..8070098f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Please read and adhere to our [Code of Conduct](https://supervision.roboflow.com - [Tests](#tests) - [License](#license) - + ## Contribution Guidelines We welcome contributions to: