From 2666d35ba279c8ccf9f3eeb02743821e12ed9993 Mon Sep 17 00:00:00 2001 From: mayank0030 Date: Thu, 11 Jun 2026 14:42:42 +0530 Subject: [PATCH 1/2] docs: fix development setup instructions in CONTRIBUTING.md --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f4f3173..f12098a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,16 +74,18 @@ Please read and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a git clone https://github.com/pyupio/safety.git ``` -2. **Set up your environment:** -- Ensure you are using Python 3.11.2. -- Install dependencies: +2. 2. **Set up your environment:** +- Ensure you are using Python 3.9 or later. +- Install the project in editable mode with development dependencies: ```bash - pip install -r requirements.txt + pip install -e ".[dev]" ``` ### Running Tests We use pytest for running tests. To run the tests locally: - ```pytest``` + ```bash + pytest + ``` Ensure all tests pass before submitting your changes. From 43c6bff97b475a8e96564f8d799a6c59d0569816 Mon Sep 17 00:00:00 2001 From: mayank0030 Date: Fri, 10 Jul 2026 10:26:15 +0530 Subject: [PATCH 2/2] fix: use Hatch-based setup instructions instead of pip install --- CONTRIBUTING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f12098a4..ed595e18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,17 +74,18 @@ Please read and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a git clone https://github.com/pyupio/safety.git ``` -2. 2. **Set up your environment:** +2. **Set up your environment using Hatch:** - Ensure you are using Python 3.9 or later. -- Install the project in editable mode with development dependencies: +- Install Hatch and create the development environment: ```bash - pip install -e ".[dev]" + pip install hatch + hatch shell ``` ### Running Tests We use pytest for running tests. To run the tests locally: ```bash - pytest + hatch run test ``` Ensure all tests pass before submitting your changes.