From 7b07a8ddf0771c3de0d537ab5295a8c891bcf63f Mon Sep 17 00:00:00 2001 From: Spencer Schrock Date: Fri, 20 Sep 2024 13:44:35 -0400 Subject: [PATCH] :book: explicitly state both check documentation files are committed (#4317) Signed-off-by: Spencer Schrock --- CONTRIBUTING.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ec03ba27458..b6c557e1363 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -225,16 +225,13 @@ A summary for each check needs to be included in the `README.md`. In most cases, to update the documentation simply edit the corresponding `.md` file, with the notable exception of the auto-generated file `checks.md`. +> [!IMPORTANT] +> **DO NOT** edit `docs/checks.md` directly, as that is an +> auto-generated file. Edit `docs/checks/internal/checks.yaml` instead. + Details about each check need to be provided in [docs/checks/internal/checks.yaml](docs/checks/internal/checks.yaml). -If you want to update its documentation, update that `checks.yaml` file. - -Whenever you modify the `checks.yaml` file, run the following to -generate `docs/checks.md`: - -```shell -make generate-docs -``` - -**DO NOT** edit `docs/checks.md` directly, as that is an -auto-generated file. Edit `docs/checks/internal/checks.yaml` instead. +If you want to update its documentation: +1. Make your edits in `docs/checks/internal/checks.yaml`. +2. Regenerate `docs/checks.md` by running `make generate-docs` +3. Commit both `docs/checks/internal/checks.yaml` and `docs/checks.md`