Skip to content

Commit 6cd801b

Browse files
ci: Exclude GitHub templates from markdownlint
The rule violations boil down to: - MD002 First header should be a top level header: This makes no sense / looks very awkward in issue or PR descriptions. - MD022 Headers should be surrounded by blank lines: It feels overly verbose to separate the comments from the headers given that there is no actual content here. Also remember this has to fit into the GitHub comment box, i.e. vertical space shouldn't be wasted if possible. - MD026 Trailing punctuation in header: I can remove the colons from the issue template headers, but I think they make sense in this case - MD012 Multiple consecutive blank lines: I left the newlines, because the user would have to always add them anyways. Ref: #121
1 parent 09cf630 commit 6cd801b

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ repos:
4949
rev: v0.12.0
5050
hooks:
5151
- id: markdownlint
52+
exclude: ^\.github/(ISSUE_TEMPLATE/.*|pull_request_template)\.md$
5253
- repo: https://github.com/Holzhaus/sourceheaders
5354
rev: v0.0.4
5455
hooks:

0 commit comments

Comments
 (0)