mirrors/flatcar-scripts
1
0
Fork 0
mirror of https://github.com/flatcar/scripts.git synced 2025-08-07 04:56:58 +02:00
Code Issues Packages Projects Releases Wiki Activity
7a0c0028b5
flatcar-scripts/changelog
History
Dongsu Park 16efbc99c0 changelog: use date format of YYYY-MM-DD 
If we use date format of DD-MM-YYYY in changelog file names, the files
will not sorted by date. e.g. 01-12-2021 will come before 25-11-2021.
Use date format of YYYY-MM-DD to make the files sorted by date.
2021-11-26 15:29:11 +01:00
..
bugfixes changelog: Add placeholder directory to add the changelogs 2021-11-24 22:50:02 +05:30
changes changelog: Add placeholder directory to add the changelogs 2021-11-24 22:50:02 +05:30
security changelog: Add placeholder directory to add the changelogs 2021-11-24 22:50:02 +05:30
updates changelog: Add placeholder directory to add the changelogs 2021-11-24 22:50:02 +05:30
README.md changelog: use date format of YYYY-MM-DD 2021-11-26 15:29:11 +01:00

README.md

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 YYYY-MM-DD-<few-words-about-the-change>.md (can be generated via: $(date '+%Y-%m-%d')-<few-words-about-the-change>.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/))