VimPlug/typeshed
1
0
Fork 0
mirror of https://github.com/davidhalter/typeshed.git synced 2026-01-30 22:55:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Run pycln as a pre-commit hook in CI (#8304)

Browse Source
This commit is contained in:
Alex Waygood
2022-07-18 08:27:28 +01:00
committed by GitHub
parent 64359528fc
commit 35616b439f
6 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -29,7 +29,7 @@ it takes a bit longer. For more details, read below.
Typeshed runs continuous integration (CI) on all pull requests. This means that
if you file a pull request (PR), our full test suite -- including our linter,
`flake8` -- is run on your PR. It also means that bots will automatically apply
changes to your PR (using `black` and `isort`) to fix any formatting issues.
changes to your PR (using `pycln`, `black` and `isort`) to fix any formatting issues.
This frees you up to ignore all local setup on your side, focus on the
code and rely on the CI to fix everything, or point you to the places that
need fixing.
@@ -82,7 +82,8 @@ terminal to install all non-pytype requirements:
## Code formatting
The code is formatted using `black` and `isort`.
The code is formatted using `black` and `isort`. Unused imports are also
auto-removed using `pycln`.
The repository is equipped with a [`pre-commit.ci`](https://pre-commit.ci/)
configuration file. This means that you don't *need* to do anything yourself to
@@ -90,9 +91,10 @@ run the code formatters. When you push a commit, a bot will run those for you
right away and add a commit to your PR.
That being said, if you *want* to run the checks locally when you commit,
you're free to do so. Either run `black` and `isort` manually...
you're free to do so. Either run `pycln`, `black` and `isort` manually...
```
pycln --all .
isort .
black .
```