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

changelog/README.md: describe purpose of the changelog entries

Browse Source
This commit is contained in:
Kai Lueke 2022-01-03 15:01:43 +01:00
parent aa9b9c6f33
commit cf7833860e
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sdk_container/src/third_party/portage-stable/changelog/README.md vendored
View File

@ -9,9 +9,11 @@ into the repository. The changes are essentially divided into 4 categories:
Based on the category the PR falls into create a new file in the respective
directory with the filename format `YYYY-MM-DD-<few-words-about-the-change>.md`
(can be generated via: `$(date '+%Y-%m-%d')-<few-words-about-the-change>.md`)
(can be generated via: `$(date '+%Y-%m-%d')-<few-words-about-the-change>.md`).
The file should contain a markdown bullet point entry `- TEXT...`.
The contents of the file should describe the changes in an elaborative manner
The contents of the file should describe the changes in a concise manner,
and only contain information relevant for the end users.
(use the past tense for the change/bugfix description to avoid confusion with
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