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

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

Browse Source 
The changelog entries should be directly used for the release notes,
thus they need to be short and hold only information relevant to the
end user, and should be in the markdown bullet point format.
This commit is contained in:
Kai Lueke 2022-01-03 15:01:43 +01:00
parent edcc436445
commit 7e9fc87f34
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
changelog/README.md
View File

@ -9,9 +9,17 @@ 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
Example for the bugfix section:
```
- The Torcx profile `docker-1.12-no` got fixed to reference the current Docker version instead of 19.03 which wasn't found on the image, causing Torcx to fail to provide Docker [PR#1456](https://github.com/flatcar-linux/coreos-overlay/pull/1456)
```
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