You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,7 @@ You can run `tox` with the following arguments:
58
58
Python version
59
59
-`tox -e spellcheck` to run a spellcheck on all the code
60
60
-`tox -e lint-some-package` to run lint checks on `some-package`
61
+
-`tox -e generate-workflows` to run creation of new CI workflows if tox environments have been updated
61
62
-`tox -e ruff` to run ruff linter and formatter checks against the entire codebase
62
63
63
64
`ruff check` and `ruff format` are executed when `tox -e ruff` is run. We strongly recommend you to configure [pre-commit](https://pre-commit.com/) locally to run `ruff` automatically before each commit by installing it as git hooks. You just need to [install pre-commit](https://pre-commit.com/#install) in your environment:
@@ -284,6 +285,7 @@ When updating the minimum supported Python version remember to:
284
285
285
286
- Remove the version in `pyproject.toml` trove classifiers
286
287
- Remove the version from `tox.ini`
288
+
- Update github workflows accordingly with `tox -e generate-workflows`
287
289
- Search for `sys.version_info` usage and remove code for unsupported versions
288
290
- Bump `py-version` in `.pylintrc` for Python version dependent checks
289
291
@@ -293,7 +295,7 @@ When adding support for a new Python release remember to:
293
295
294
296
- Add the version in `tox.ini`
295
297
- Add the version in `pyproject.toml` trove classifiers
296
-
- Update github workflows accordingly; lint and benchmarks use the latest supported version
298
+
- Update github workflows accordingly with `tox -e generate-workflows`; lint and benchmarks use the latest supported version
0 commit comments