diff options
| author | Sascha Grunert <Sascha.Grunert@rohde-schwarz.com> | 2016-10-08 13:02:55 +0200 |
|---|---|---|
| committer | Sascha Grunert <Sascha.Grunert@rohde-schwarz.com> | 2016-10-08 13:02:55 +0200 |
| commit | 78ced7f377b62e2beddbf8228e53d48e5f46d6af (patch) | |
| tree | 1a3e628a80ac11dfbe3b5b530827528641cdff8c | |
| parent | ce9532ff2df45f14273621f120d8399355beb350 (diff) | |
Improved README format
| -rw-r--r-- | README.md | 9 |
1 files changed, 5 insertions, 4 deletions
@@ -20,15 +20,16 @@ Table of contents: ## TL;DR [tldr]: #tldr -Maintaining changelogs can be time-consuming, especially when multiple persons work on the same project. If you maintain a -separate file, merge conflicts and additional release work is sure to follow. +Maintaining changelogs can be time-consuming, especially when multiple persons work on the same project. If you maintain +a separate file, merge conflicts and additional release work is sure to follow. -Sometimes complete entries are lost during merge conflict resolution, people forget to mention something or links between issues and actual commits are missing. +Sometimes complete entries are lost during merge conflict resolution, people forget to mention something or links +between issues and actual commits are missing. It would be great, if we could use the commit history of [git](https://git-scm.com/) to generate a *beautiful* changelog without any additional work needed. -This is where **git-journal** jumps in. +**This is where git-journal jumps in.** To ensure this auto-generation a framework to write more sensible commit messages is needed. Single commit messages should contain one logical change of the project which is described in a standardized way. This results in a much |