[GH-ISSUE #228] All rules should include Rationale #197

New issue

Closed

opened 2026-03-03 01:24:36 +03:00 by kerem · 1 comment

kerem commented

2026-03-03 01:24:36 +03:00

Owner

Originally created by @displague on GitHub (Oct 14, 2019).
Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/228

The use of this linter in a project should not require a developer to use the existence of this linter as the primary support.

Some rules include rationale, while others do not. It would build the case for markdown lint adoption if all rules included well reasoned and supported rationale, including references to deeper discussions for each rule.

https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026---trailing-punctuation-in-heading is an example of a rule that offers no rationale.

Originally created by @displague on GitHub (Oct 14, 2019). Original GitHub issue: https://github.com/DavidAnson/markdownlint/issues/228 The use of this linter in a project should not require a developer to use the existence of this linter as the primary support. Some rules include rationale, while others do not. It would build the case for markdown lint adoption if all rules included well reasoned and supported rationale, including references to deeper discussions for each rule. https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md#md026---trailing-punctuation-in-heading is an example of a rule that offers no rationale.