Skip to content

Commit

Permalink
📖 explicitly state both check documentation files are committed (#4317)
Browse files Browse the repository at this point in the history
Signed-off-by: Spencer Schrock <[email protected]>
  • Loading branch information
spencerschrock authored Sep 20, 2024
1 parent 7b12b99 commit 7b07a8d
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

0 comments on commit 7b07a8d

Please sign in to comment.