SAP/abapGit
1
0
Fork 0
mirror of https://github.com/abapGit/abapGit.git synced 2025-05-01 12:20:51 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Docs: Formatting of changelog description (#4819)

Browse Source 
Co-authored-by: Lars Hvam <larshp@hotmail.com>
This commit is contained in:
Marc Bernard 2021-06-04 15:14:43 +02:00 committed by GitHub
parent 887e7dd332
commit ce731ecd22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/collections/_development/guide-changelog.md
View File

@ -11,12 +11,14 @@ A file named as pattern `CHANGELOG*` or `changelog*`
Changelog file should have a specific format: Changelog file should have a specific format:
Header with the title Header with the title
``` ```
abapGit changelog abapGit changelog
================= =================
``` ```
A legend A legend
``` ```
Legend Legend
------ ------
@ -27,14 +29,14 @@ Legend
``` ```
Notes section using header format: Notes section using header format:
* Date in format YYYY-MM-DD * Date in format YYYY-MM-DD followed by [Semantic version](https://semver.org/)
* [Semantic version](https://semver.org/)
* Separator: ------------------ * Separator: ------------------
* Version notes * Version notes using a prefix as described in the legend
``` ```
2020-06-29 v1.97.0 2020-06-29 v1.97.0
------------------ ------------------
+ Notes..... + 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.