From 663fee4c68c6c7994dbb65126093faa6797df3dc Mon Sep 17 00:00:00 2001 From: Sayan Chowdhury Date: Fri, 19 Nov 2021 13:13:27 +0530 Subject: [PATCH] changelog: Add placeholder directory to add the changelogs Signed-off-by: Sayan Chowdhury --- CHANGELOG.md | 0 changelog/README.md | 22 ++++++++++++++++++++++ changelog/bugfixes/.gitkeep | 0 changelog/changes/.gitkeep | 0 changelog/security/.gitkeep | 0 changelog/updates/.gitkeep | 0 6 files changed, 22 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 changelog/README.md create mode 100644 changelog/bugfixes/.gitkeep create mode 100644 changelog/changes/.gitkeep create mode 100644 changelog/security/.gitkeep create mode 100644 changelog/updates/.gitkeep diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/changelog/README.md b/changelog/README.md new file mode 100644 index 0000000000..96eaa03d74 --- /dev/null +++ b/changelog/README.md @@ -0,0 +1,22 @@ +The `changelog` directory contains the description of the changes introduced +into the repository. The changes are essentially divided into 4 categories: +- changes: PRs bringing Changes and/or Enhancements +- bugfixes: PRs fixing existing issues +- security: PRs fixing security issues +- updates: PRs updating packages + +## How to add the file + +Based on the category the PR falls into create a new file in the respective +directory with the filename format `DD-MM-YYYY-.md` +(can be generated via: `$(date '+%d-%m-%Y')-.md`) + +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 +and follow a standard format. + +As `Updates` refer to the package updates, the description of the file should +be of the following format: `Package Name [Version](link to changelog)` +Example: `Linux ([5.10.77](https://lwn.net/Articles/874852/))` diff --git a/changelog/bugfixes/.gitkeep b/changelog/bugfixes/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/changelog/changes/.gitkeep b/changelog/changes/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/changelog/security/.gitkeep b/changelog/security/.gitkeep new file mode 100644 index 0000000000..e69de29bb2 diff --git a/changelog/updates/.gitkeep b/changelog/updates/.gitkeep new file mode 100644 index 0000000000..e69de29bb2