docs: fix broken contributor setup instructions in CONTRIBUTING.md#321
Open
tungyhardDevOps wants to merge 1 commit into
Open
docs: fix broken contributor setup instructions in CONTRIBUTING.md#321tungyhardDevOps wants to merge 1 commit into
tungyhardDevOps wants to merge 1 commit into
Conversation
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.
Closes #303
Problem
The Before Start section of
CONTRIBUTING.mddocuments a setup flow that doesn't work against the current repo:bash install.sh— there is noinstall.shin the repository.cat main.pyanduvicorn app:app— there is nomain.pyorapp.py.```shcode fences in the section are malformed.tox.iniexists, but itsenvlisttargets Python 3.6–3.9, while the project now requires Python ≥ 3.10; the actual maintained test path is pytest via theMakefile.(As noted on the issue, this section "needs an update.")
Fix
Rewrote Before Start and Testing to match the repo's real tooling, verified against
pyproject.toml,poetry.lock, and theMakefile:pip install poetry→poetry install→poetry shell(poetry installpulls in the dev tools: pytest, black, isort, flake8, mypy).make test(pytest + coverage) orpytestdirectly.make lintandmake format_code.Docs-only change — no code touched.