Contributing and tools #812
Conversation
ivantodorovich
force-pushed
the
contributing-and-tools
branch
from
5908c29
to
009b463
Compare
|
📝 Docs preview for commit 009b463 at: https://5b2166b5.typertiangolo.pages.dev |
svlandeg
added
docs
ivantodorovich
force-pushed
the
contributing-and-tools
branch
from
009b463
to
3e75d7c
Compare
|
📝 Docs preview for commit 3e75d7c at: https://976d412f.typertiangolo.pages.dev |
Before this commit, the linting was done in the test matrix (once per python version). This is not necessary, as the linting is the same for all versions. Now, the linting is fully delegated to pre-commit, and executed as a separate job.
* Remove the outdated `flit` section * Mention pre-commit and how to use it * Describe how to set-up the development dependencies * Describe how to run tests
ivantodorovich
force-pushed
the
contributing-and-tools
branch
from
3e75d7c
to
15a1dcd
Compare
|
📝 Docs preview for commit 15a1dcd at: https://0b4673db.typertiangolo.pages.dev |
|
Hi @ivantodorovich, thanks for these contributions! To get this reviewed and merged more easily, I suggest to break this PR up into atomic bits, each representing one functionality change or improvement. |
| $ pip install flit | ||
|
|
||
| ---> 100% | ||
| $ pip install --editable . |
There was a problem hiding this comment.
This does require at least pip 21.3, as it'll otherwise fail with a note about not finding setup.py or setup.cfg. So it might be good to add that as a note here as well.
|
As most of these edits have gone out-of-date with the current |
📝 Update the Contributing documentation
flitsection⬆ Bump ruff pre-commit hook
This also does a minor formatting diff on some files
🤖 Add mypy pre-commit hook
With this, it's not needed to install
mypydirectly, as pre-commit will do it in a separate virtual env🌱 Run lint in a separate ci job
Before this commit, the linting was done in the test matrix (once per python version). This is not necessary, as the linting is the same for all versions.
Now, the linting is fully delegated to pre-commit, and executed as a separate job.
By doing this we delegate
ruffcompletely topre-commit, and so the linting script and theruffrequirement for testing is removed.