diff --git a/changelog/README.md b/changelog/README.md index 8c61ac11cc..4a94640eed 100644 --- a/changelog/README.md +++ b/changelog/README.md @@ -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-.md` -(can be generated via: `$(date '+%Y-%m-%d')-.md`) +(can be generated via: `$(date '+%Y-%m-%d')-.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