Skip to content

docs: fix development setup instructions in CONTRIBUTING.md #884

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

Open
mayank0030 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix development setup instructions in CONTRIBUTING.md #884

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2666d35
docs: fix development setup instructions in CONTRIBUTING.md
mayank0030 Jun 11, 2026
43c6bff
fix: use Hatch-based setup instructions instead of pip install
mayank0030 Jul 10, 2026
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
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,16 +74,19 @@ 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. **Set up your environment using Hatch:**
- Ensure you are using Python 3.9 or later.
- Install Hatch and create the development environment:
```bash
pip install -r requirements.txt
pip install hatch
hatch shell
```

### Running Tests
We use pytest for running tests. To run the tests locally:
```pytest```
```bash
hatch run test
```

Ensure all tests pass before submitting your changes.

Expand Down