Commit 8262343
committed
Update readme for recent tooling changes
This also reorganizes the "Specific tools" list, since they are all
configured in pyproject.toml now (only flake8 was not before, and
it was removed in favor of ruff in #1862). In doing so, I've also
added brief parenthesized phrases to characterize what each of
these four tools is for, so readers don't have to look around as
much to understand most of the tooling GitPython has set up.1 parent 3a6ee9e commit 8262343
1 file changed
Lines changed: 9 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -156,12 +156,14 @@ To test, run: | |||
| 156 | 156 | pytest | |
| 157 | 157 | ``` | |
| 158 | 158 | ||
| 159 | - To lint, and apply automatic code formatting, run: | ||
| 159 | + To lint, and apply some linting fixes as well as automatic code formatting, run: | ||
| 160 | 160 | ||
| 161 | 161 | ```sh | |
| 162 | 162 | pre-commit run --all-files | |
| 163 | 163 | ``` | |
| 164 | 164 | ||
| 165 | + This includes the linting and autoformatting done by Ruff, as well as some other checks. | ||
| 166 | + | ||
| 165 | 167 | To typecheck, run: | |
| 166 | 168 | ||
| 167 | 169 | ```sh | |
@@ -170,18 +172,20 @@ mypy -p git | |||
| 170 | 172 | ||
| 171 | 173 | #### CI (and tox) | |
| 172 | 174 | ||
| 173 | - The same linting, and running tests on all the different supported Python versions, will be performed: | ||
| 175 | + Style and formatting checks, and running tests on all the different supported Python versions, will be performed: | ||
| 174 | 176 | ||
| 175 | 177 | - Upon submitting a pull request. | |
| 176 | 178 | - On each push, *if* you have a fork with GitHub Actions enabled. | |
| 177 | 179 | - Locally, if you run [`tox`](https://tox.wiki/) (this skips any Python versions you don't have installed). | |
| 178 | 180 | ||
| 179 | 181 | #### Configuration files | |
| 180 | 182 | ||
| 181 | - Specific tools: | ||
| 183 | + Specific tools are all configured in the `./pyproject.toml` file: | ||
| 182 | 184 | ||
| 183 | - - Configurations for `mypy`, `pytest`, `coverage.py`, and `black` are in `./pyproject.toml`. | ||
| 184 | - - Configuration for `ruff` is in the `pyproject.toml` file. | ||
| 185 | + - `pytest` (test runner) | ||
| 186 | + - `coverage.py` (code coverage) | ||
| 187 | + - `ruff` (linter and formatter) | ||
| 188 | + - `mypy` (type checker) | ||
| 185 | 189 | ||
| 186 | 190 | Orchestration tools: | |
| 187 | 191 | ||
0 commit comments