From fe73ac384427fb6cd41c1c1fd547f0fad90b713f Mon Sep 17 00:00:00 2001 From: Kai Lueke Date: Mon, 3 Jan 2022 15:08:57 +0100 Subject: [PATCH] Revert "changelog/README.md: describe purpose of the changelog entries" This reverts commit 3a4bb3345e1d70dfe44b4d213088e05a99a23e67. --- .../src/third_party/portage-stable/changelog/README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/sdk_container/src/third_party/portage-stable/changelog/README.md b/sdk_container/src/third_party/portage-stable/changelog/README.md index 552e5a18aa..8c61ac11cc 100644 --- a/sdk_container/src/third_party/portage-stable/changelog/README.md +++ b/sdk_container/src/third_party/portage-stable/changelog/README.md @@ -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-.md` -(can be generated via: `$(date '+%Y-%m-%d')-.md`). -The file should contain a markdown bullet point entry `- TEXT...`. +(can be generated via: `$(date '+%Y-%m-%d')-.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