diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index 5f34530f80341a..10bf234088a1a4 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -312,6 +312,9 @@ of the list. The most recent release for each release line is shown in **bold** in the index. When updating the index, please make sure to update the display accordingly by removing the bold styling from the previous release. +Run `make format-md` to ensure the `CHANGELOG_Vx.md` and `CHANGELOG.md` files +are formatted correctly. + #### Step 3: Update any REPLACEME and DEP00XX tags in the docs If this release includes new APIs then it is necessary to document that they