mirror of
https://github.com/flatcar/scripts.git
synced 2025-08-17 01:46:58 +02:00
Revert "changelog/README.md: describe purpose of the changelog entries"
This reverts commit 3a4bb3345e1d70dfe44b4d213088e05a99a23e67.
This commit is contained in:
parent
cf7833860e
commit
fe73ac3844
@ -9,11 +9,9 @@ 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`).
|
||||
The file should contain a markdown bullet point entry `- TEXT...`.
|
||||
(can be generated via: `$(date '+%Y-%m-%d')-<few-words-about-the-change>.md`)
|
||||
|
||||
The contents of the file should describe the changes in a concise manner,
|
||||
and only contain information relevant for the end users.
|
||||
The contents of the file should describe the changes in an elaborative manner
|
||||
(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
|
||||
|
Loading…
Reference in New Issue
Block a user