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

This reverts commit 3a4bb3345e1d70dfe44b4d213088e05a99a23e67.
This commit is contained in:
Kai Lueke 2022-01-03 15:08:57 +01:00
parent cf7833860e
commit fe73ac3844

View File

@ -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 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` 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 a concise manner, The contents of the file should describe the changes in an elaborative manner
and only contain information relevant for the end users.
(use the past tense for the change/bugfix description to avoid confusion with (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 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