Skip to content

Commit 47b0541

Browse files
Add generate-workflows info to CONTRIBUTING (#4266)
1 parent ca774ee commit 47b0541

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ You can run `tox` with the following arguments:
5858
Python version
5959
- `tox -e spellcheck` to run a spellcheck on all the code
6060
- `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
6162
- `tox -e ruff` to run ruff linter and formatter checks against the entire codebase
6263

6364
`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:
284285

285286
- Remove the version in `pyproject.toml` trove classifiers
286287
- Remove the version from `tox.ini`
288+
- Update github workflows accordingly with `tox -e generate-workflows`
287289
- Search for `sys.version_info` usage and remove code for unsupported versions
288290
- Bump `py-version` in `.pylintrc` for Python version dependent checks
289291

@@ -293,7 +295,7 @@ When adding support for a new Python release remember to:
293295

294296
- Add the version in `tox.ini`
295297
- 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
297299
- Update `.pre-commit-config.yaml`
298300
- Update tox examples in the documentation
299301

0 commit comments

Comments
 (0)