Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitc66257e

Browse files
committed
Update readme for recent tooling changes
- `make lint` no longer lints without making changes. This has been the case since#1862, because `--fix` is used. (I don't think anyone was really using `make lint`, but just in case, we should avoid saying it still never changes any files.) With#1865, there will be more ways that files can be changed.- `black` is no longer used, having been replaced by `ruff`. This will be the case as of#1865.This also reorganizes the "Specific tools" list, since they are allconfigured in pyproject.toml now (only flake8 was not before, andit was removed in favor of ruff in#1862). In doing so, I've alsoadded brief parenthesized phrases to characterize what each ofthese four tools is for, so readers don't have to look around asmuch to understand most of the tooling GitPython has set up.
1 parenta6a2a37 commitc66257e

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

‎README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -156,14 +156,13 @@ To test, run:
156156
pytest
157157
```
158158

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

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

165-
- Linting without modifying code can be done with:`make lint`
166-
- Auto-formatting without other lint checks can be done with:`black .`
165+
This includes the linting and autoformatting done by Ruff, as well as some other checks.
167166

168167
To typecheck, run:
169168

@@ -173,18 +172,20 @@ mypy -p git
173172

174173
####CI (and tox)
175174

176-
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:
177176

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

182181
####Configuration files
183182

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

186-
- Configurations for`mypy`,`pytest`,`coverage.py`, and`black` are in`./pyproject.toml`.
187-
- 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)
188189

189190
Orchestration tools:
190191

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp