From a81d3898d804a8a40db9b2300a727b28a647856f Mon Sep 17 00:00:00 2001 From: Krzesimir Nowak Date: Tue, 30 Nov 2021 14:49:47 +0100 Subject: [PATCH] changelog: Update the update changelog format Mention that it should be written as a bullet list. Also, match the format to the example (put the version link inside parentheses). --- .../src/third_party/coreos-overlay/changelog/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/sdk_container/src/third_party/coreos-overlay/changelog/README.md b/sdk_container/src/third_party/coreos-overlay/changelog/README.md index 11498d2f23..8c61ac11cc 100644 --- a/sdk_container/src/third_party/coreos-overlay/changelog/README.md +++ b/sdk_container/src/third_party/coreos-overlay/changelog/README.md @@ -17,6 +17,7 @@ the imperative voice for actions the user should do as a result). Security fixes of upstream packages and package updates can be kept short in most cases and follow a standard format. -As `Updates` refer to the package updates, the description of the file should -be of the following format: `Package Name [Version](link to changelog)` -Example: `Linux ([5.10.77](https://lwn.net/Articles/874852/))` +As `Updates` refer to the package updates, contents of the file should be of +the following format: `- Package Name ([Version](link to changelog))`. Example: +`- Linux ([5.10.77](https://lwn.net/Articles/874852/))`. Note the leading dash +that will create a bullet list in the rendered markdown.