Skip to content

Commit 8262343

Browse files
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 gitpython-developers#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

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

Diff for: README.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -156,12 +156,14 @@ To test, run:
156156
pytest
157157
```
158158

159-
To lint, and apply automatic code formatting, run:
159+
To lint, and apply some linting fixes as well as automatic code formatting, run:
160160

161161
```sh
162162
pre-commit run --all-files
163163
```
164164

165+
This includes the linting and autoformatting done by Ruff, as well as some other checks.
166+
165167
To typecheck, run:
166168

167169
```sh
@@ -170,18 +172,20 @@ mypy -p git
170172

171173
#### CI (and tox)
172174

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:
174176

175177
- Upon submitting a pull request.
176178
- On each push, *if* you have a fork with GitHub Actions enabled.
177179
- Locally, if you run [`tox`](https://tox.wiki/) (this skips any Python versions you don't have installed).
178180

179181
#### Configuration files
180182

181-
Specific tools:
183+
Specific tools are all configured in the `./pyproject.toml` file:
182184

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)
185189

186190
Orchestration tools:
187191

0 commit comments

Comments
 (0)