From 42946fed8f8e28d9141f9c324055463fc55b7df6 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Thu, 29 Dec 2022 12:18:59 +1000 Subject: [PATCH] CONTRIBUTING.md: update `pre-commit` info with `make` and `rake` --- CONTRIBUTING.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69cf86d5e..f09f35cbe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,6 +37,14 @@ Sometimes you might need to skip one or more hooks which can be done with the `S `$ SKIP=yamllint git commit -m "foo"` +For convenience, we have added `pre-commit run --all-files` and `pre-commit autoupdate` +to both the Makefile and the Rakefile. Run them with: + +- `make check` or `rake check` +- `make checkupdate` or `rake checkupdate` + +### pre-commit quick links + - [Quick start](https://pre-commit.com/#quick-start) - [Usage](https://pre-commit.com/#usage) - [pre-commit autoupdate](https://pre-commit.com/#pre-commit-autoupdate)