From ce731ecd22383051094799d4f2fee5b960eeb8e9 Mon Sep 17 00:00:00 2001 From: Marc Bernard <59966492+mbtools@users.noreply.github.com> Date: Fri, 4 Jun 2021 15:14:43 +0200 Subject: [PATCH] Docs: Formatting of changelog description (#4819) Co-authored-by: Lars Hvam --- docs/collections/_development/guide-changelog.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/collections/_development/guide-changelog.md b/docs/collections/_development/guide-changelog.md index 3256df01b..913a5a45b 100644 --- a/docs/collections/_development/guide-changelog.md +++ b/docs/collections/_development/guide-changelog.md @@ -11,12 +11,14 @@ A file named as pattern `CHANGELOG*` or `changelog*` Changelog file should have a specific format: Header with the title + ``` abapGit changelog ================= ``` A legend + ``` Legend ------ @@ -27,14 +29,14 @@ Legend ``` Notes section using header format: -* Date in format YYYY-MM-DD -* [Semantic version](https://semver.org/) +* Date in format YYYY-MM-DD followed by [Semantic version](https://semver.org/) * Separator: ------------------ -* Version notes +* Version notes using a prefix as described in the legend + ``` 2020-06-29 v1.97.0 ------------------ + Notes..... ``` -Check [abapGit changelog](https://github.com/abapGit/abapGit/blob/main/changelog.txt) as an example +Check [abapGit changelog](https://github.com/abapGit/abapGit/blob/main/changelog.txt) as an example.