docs: remove references to nonexistent requirements-dev.txt#123
Merged
Goldokpa merged 1 commit intoJul 7, 2026
Merged
Conversation
GETTING_STARTED.md, CONTRIBUTING.md and PROJECT_STRUCTURE.md instruct contributors to run 'pip install -r requirements-dev.txt', but that file does not exist, so setup fails at that step. All development tools (pytest, pytest-cov, black, flake8) are already provided by requirements.txt, so the extra install step is removed. PROJECT_STRUCTURE.md's dev-setup snippet now installs requirements.txt before the editable install so the documented flow works end to end.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
GETTING_STARTED.md,CONTRIBUTING.md, andPROJECT_STRUCTURE.mdinstruct contributors to runpip install -r requirements-dev.txt, but that file does not exist in the repo, so setup fails at that step. All development tools (pytest, pytest-cov, black, flake8) are already provided byrequirements.txt, so the extra install step is removed.PROJECT_STRUCTURE.md's dev-setup snippet now installsrequirements.txtbefore the editable install so the documented flow works end to end.Related Issue
N/A — documentation fix found during setup.
Type of Change
Key Changes
pip install -r requirements-dev.txtfromGETTING_STARTED.mdCONTRIBUTING.mdPROJECT_STRUCTURE.mdto installrequirements.txtbefore the editable installTesting
Checklist