mirrors/flatcar-scripts
1
0
Fork 0
mirror of https://github.com/flatcar/scripts.git synced 2025-09-22 14:11:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

changelog: use a specific project name in the example

Browse Source 
To be able to distinguish changelog entries from each other, we should
write a specific project name, e.g. scripts, instead of `PR`.
Changelog entries with a simple `PR` usually cause so much additional
rework when doing actual releases.
This commit is contained in:
Dongsu Park 2022-05-06 12:19:37 +02:00
parent 8c38c98533
commit a529098deb
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog/README.md
View File

@ -15,7 +15,7 @@ The file should contain a markdown bullet point entry (`- TEXT...`).
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 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 [scripts#1456](https://github.com/flatcar-linux/scripts/pull/1456)
```
The contents of the file should describe the changes in a concise manner,