opt to avoid "" directives in every …

…CHANGELOG.md file and choose options that work for all .md files
open-telemetry · May 23, 2024 · 2e03f59 · 2e03f59
1 parent 53a3adc
commit 2e03f59
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/.markdownlint-cli2.jsonc b/.markdownlint-cli2.jsonc
@@ -6,9 +6,10 @@
     "MD024": false,
     "MD033": false,
     "MD041": false,
-    // XXX Rules to discuss:
-    "MD012": false // no-multiple-blanks, common in CHANGELOG.md files, ~1700 hits in changelog files
-    // "MD004": { "style": "dash" } // ul-style, ~3800 hits in 63 changelog files, XXX discuss just using "consistent" new default for dash
+    // MD004/ul-style. We prefer dash, but generated CHANGELOG.md files use
+    // asterisk. The default "consistent" is a good compromise.
+    "MD004": { "style": "consistent" },
+    "MD012": false // no-multiple-blanks; disabled because common in CHANGELOG.md files
   },
   "gitignore": true,
   "noBanner": true,