Skip to content

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

Open
mayank0030 wants to merge 2 commits into
pyupio:mainfrom
mayank0030:improve-contributing-docs
Open

docs: fix development setup instructions in CONTRIBUTING.md#884
mayank0030 wants to merge 2 commits into
pyupio:mainfrom
mayank0030:improve-contributing-docs

Conversation

@mayank0030

Copy link
Copy Markdown

Fixed the development setup instructions in CONTRIBUTING.md.

Changes made:

  • Updated Python version guidance to reflect supported versions (Python 3.9+)
  • Replaced the outdated pip install -r requirements.txt command with pip install -e ".[dev]"
  • Improved the test-running instructions and formatting

Ref #572

@coderabbitai

coderabbitai Bot commented Jun 11, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: eb15ff9a-5e68-451e-bd88-ba69d419f254

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@arushiiii18

Copy link
Copy Markdown

Hi! I tested this setup locally while onboarding as a first-time contributor and noticed that:

pip install -e ".[dev]"

produces:

WARNING: safety 3.8.1 does not provide the extra 'dev'

The command still completes, but the dev extra appears to be ignored.

I initially thought everything was working because pytest was available on my machine, but later realized it was coming from a globally installed pytest executable rather than the local environment.

Running hatch env show also shows that the repository already defines its development environments and dependencies through Hatch.

Since the repository seems to use Hatch for development environments, would a Hatch-based setup workflow be more appropriate for the contributing instructions?

@mayank0030

Copy link
Copy Markdown
Author

Hey, thanks for catching that , You're absolutely right — pip install -e ".[dev]" gives that warning because there's no dev extra defined. I hadn't noticed it was being silently ignored.

I've updated the instructions to use Hatch instead, since the project already has Hatch environments set up in pyproject.toml. So now it's just:

pip install hatch
hatch shell
And hatch run test for running tests.

Let me know if that looks better!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants