docs: fix development setup instructions in CONTRIBUTING.md#884
docs: fix development setup instructions in CONTRIBUTING.md#884mayank0030 wants to merge 2 commits into
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
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 I initially thought everything was working because Running Since the repository seems to use Hatch for development environments, would a Hatch-based setup workflow be more appropriate for the contributing instructions? |
|
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 Let me know if that looks better! |
Fixed the development setup instructions in CONTRIBUTING.md.
Changes made:
pip install -r requirements.txtcommand withpip install -e ".[dev]"Ref #572