Skip to content

Commit 967f895

Browse files
authored
NO-JIRA: explain pre-commit usage in CONTRIBUTING.md (#1633)
1 parent e94f5bf commit 967f895

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,13 @@ Pull requests are the best way to propose changes to the notebooks repository:
4040
- Run the [piplock-renewal.yaml](https://github.com/opendatahub-io/notebooks/blob/main/.github/workflows/piplock-renewal.yaml) against your fork branch, check [here](https://github.com/opendatahub-io/notebooks/blob/main/README.md) for more info.
4141
- Test the changes locally, by manually running the `$ make jupyter-${NOTEBOOK_NAME}-ubi8-python-3.8` from the terminal.
4242
43+
### Working with linters
44+
45+
- Run pre-commit before you commit, to lint the Python sources that have been put under its management
46+
```
47+
uv run pre-commit run --all-files
48+
```
49+
- If you like, you can install pre-commit to run automatically using `uv run pre-commit install`, as per its [install instructions](https://pre-commit.com/#3-install-the-git-hook-scripts)
4350
4451
### Some basic instructions how to apply the new tests into [openshift-ci](https://github.com/openshift/release)
4552

0 commit comments

Comments
 (0)