mirror of
https://github.com/flatcar/scripts.git
synced 2026-05-05 20:26:44 +02:00
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). Update the existing changelogs too. Drop the headers, so it will be easier to process the files with a script.
This commit is contained in:
parent
58451d607d
commit
ea2db192c9
@ -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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user