From ea3942057f9a826af035ab9e81b52f9178995b5e Mon Sep 17 00:00:00 2001
From: June <june@jsts.xyz>
Date: Wed, 11 Sep 2024 03:51:31 +0200
Subject: [PATCH] docs: enhance the git annotated tag and release notes
 templates

- Give them a better general structure by having a "Relevant and/or
  Breaking Changes" and an "Other Changes" section.
- Use more minimal markup in the git annotated tag template as that
  works better for annotated tags.
- Use nicer and more useful placeholder values.
- Get rid of unnecessary descriptions.
---
 docs/release_notes_template.md | 15 +++++++++++++--
 git_annotated_tag_template     | 12 +++++++-----
 2 files changed, 20 insertions(+), 7 deletions(-)

diff --git a/docs/release_notes_template.md b/docs/release_notes_template.md
index 740ef00..66ac266 100644
--- a/docs/release_notes_template.md
+++ b/docs/release_notes_template.md
@@ -4,12 +4,23 @@ Top Bar Organizer vX includes the following changes:
 
 The following relevant and/or breaking changes of this version:
 
-<list relevant and/or breaking changes of this version here>
+## Breaking Change
+
+Description
+
+## Relevant Change
+
+Description
+
+# Other Changes
+
+- a change
+- another change
 
 # `git shortlog`
 
 The git shortlog for this version:
 
 ```
-<paste the git shortlog for this version here>
+git shortlog vX-1..vX
 ```
diff --git a/git_annotated_tag_template b/git_annotated_tag_template
index 5f9a5c0..2c66d8d 100644
--- a/git_annotated_tag_template
+++ b/git_annotated_tag_template
@@ -1,7 +1,9 @@
-Top Bar Organizer vX includes the following changes:
+Top Bar Organizer vX
 
-# Relevant and/or Breaking Changes
+Relevant and/or Breaking Changes:
+- breaking change: description
+- relevant change: description
 
-The following relevant and/or breaking changes of this version:
-
-<list relevant and/or breaking changes of this version here>
+Other Changes:
+- a change
+- another change