mirrors/flatcar-scripts
1
0
Fork 0
mirror of https://github.com/flatcar/scripts.git synced 2025-08-17 18:06:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

changelog: Update the update changelog format

Browse Source 
Mention that it should be written as a bullet list. Also, match the
format to the example (put the version link inside parentheses).
This commit is contained in:
Krzesimir Nowak 2021-11-30 14:49:47 +01:00
parent 7c808058b1
commit a81d3898d8
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
sdk_container/src/third_party/coreos-overlay/changelog/README.md vendored
View File

@ -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 fixes of upstream packages and package updates can be kept short in most cases
and follow a standard format. and follow a standard format.
As `Updates` refer to the package updates, the description of the file should As `Updates` refer to the package updates, contents of the file should be of
be of the following format: `Package Name [Version](link to changelog)` the following format: `- Package Name ([Version](link to changelog))`. Example:
Example: `Linux ([5.10.77](https://lwn.net/Articles/874852/))` `- Linux ([5.10.77](https://lwn.net/Articles/874852/))`. Note the leading dash
that will create a bullet list in the rendered markdown.