Reformat release history with headings (#140)

Formatting the release history with headings makes it much more scannable (for me, at least), and also helps developers using assistive technology to scan the page. It also makes the notes for individual releases linkable.
dbader · Dec 13, 2024 · 950765c · 950765c
1 parent 8cca1bd
commit 950765c
Show file tree

Hide file tree

Showing 2 changed files with 307 additions and 240 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -147,27 +147,27 @@ For changes to this repo, follow the [local development](#local-development) ste
     - Add a new “in development” section to the top of the release history in `README.md`:
 
         ```markdown
-        * In Development:
+        ### In Development:
 
-            **Breaking Changes:**
+        **Breaking Changes:**
 
-            TBD
+        TBD
 
-            **New Features:**
+        **New Features:**
 
-            TBD
+        TBD
 
-            **Deprecations:**
+        **Deprecations:**
 
-            TBD
+        TBD
 
-            **Bug Fixes:**
+        **Bug Fixes:**
 
-            TBD
+        TBD
 
-            **Maintenance:**
+        **Maintenance:**
 
-            TBD
+        TBD
 
         [View diff](https://github.com/dbader/node-datadog-metrics/compare/v<VERSION_NUMBER>...main)
         ```