Skip to content

Commit 2617afa

Browse files
committed
🧪 Integrate pymarkdown into pre-commit config
This is meant to ensure consistency in our Markdown content source. Ref: https://pymarkdown.rtfd.io
1 parent d367d9f commit 2617afa

10 files changed

Lines changed: 292 additions & 196 deletions

File tree

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
2+
23
name: Bug report
34
about: Create a report to help us improve
5+
46
---
57

68
<!-- Describe the issue briefly here. -->

.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,32 @@
11
---
2+
23
name: Feature request
34
about: Suggest an idea for this project
5+
46
---
57

68
#### What's the problem this feature will solve?
79

8-
<!-- What are you trying to do, that you are unable to achieve with pip-tools as it currently stands? -->
10+
<!--
11+
What are you trying to do, that you are unable to achieve with pip-tools as it
12+
currently stands?
13+
-->
914

1015
#### Describe the solution you'd like
1116

1217
<!-- A clear and concise description of what you want to happen. -->
1318

14-
<!-- Provide examples of real-world use cases that this would enable and how it solves the problem described above. -->
19+
<!--
20+
Provide examples of real-world use cases that this would enable and how it
21+
solves the problem described above.
22+
-->
1523

1624
#### Alternative Solutions
1725

18-
<!-- Have you tried to workaround the problem using pip-tools or other tools? Or a different approach to solving this issue? Please elaborate here. -->
26+
<!--
27+
Have you tried to workaround the problem using pip-tools or other tools? Or a
28+
different approach to solving this issue? Please elaborate here.
29+
-->
1930

2031
#### Additional context
2132

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,14 @@
33
##### Contributor checklist
44

55
- [ ] Included tests for the changes.
6-
- [ ] A change note is created in `changelog.d/` (see [`changelog.d/README.md`](https://github.com/jazzband/pip-tools/blob/main/changelog.d/#readme) for instructions) or the PR text says "no changelog needed".
6+
- [ ] A change note is created in `changelog.d/` (see [`changelog.d/README.md`]
7+
for instructions) or the PR text says "no changelog needed".
8+
9+
[`changelog.d/README.md`]:
10+
https://github.com/jazzband/pip-tools/blob/main/changelog.d/#readme
711

812
##### Maintainer checklist
913

1014
- [ ] If no changelog is needed, apply the `bot:chronographer:skip` label.
11-
- [ ] Assign the PR to an existing or new milestone for the target version (following [Semantic Versioning](https://blog.versioneye.com/2014/01/16/semantic-versioning/)).
15+
- [ ] Assign the PR to an existing or new milestone for the target version
16+
(following Semantic Versioning).

.pre-commit-config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,9 @@ repos:
107107
hooks:
108108
- id: actionlint
109109

110+
- repo: https://github.com/jackdewinter/pymarkdown.git
111+
rev: v0.9.33
112+
hooks:
113+
- id: pymarkdown
114+
110115
...

0 commit comments

Comments
 (0)