Skip to content

Commit 4e29869

Browse files
authored
maintain: Add GitHub issue templates
1 parent dad3d12 commit 4e29869

File tree

3 files changed

+100
-0
lines changed

3 files changed

+100
-0
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Why does Mdformat use backslash to escape my Markdown engine specific syntax? ⁉️
3+
url: https://github.com/executablebooks/mdformat?tab=readme-ov-file#why-does-mdformat-backslash-escape-special-syntax-specific-to-mkdocs--hugo--obsidian--github--some-other-markdown-engine
4+
about: It's likely you need to install a plugin. See the FAQ more info.

.github/ISSUE_TEMPLATE/bug.yaml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Report a bug 🐛
2+
description: Mdformat crashes or exit code is non-zero, output is invalid CommonMark, rendered document is visually different after formatting...
3+
labels: [bug]
4+
body:
5+
- type: textarea
6+
id: describe
7+
attributes:
8+
label: Describe the bug
9+
description: |
10+
Provide a short description (one or two sentences) about the problem. What did you expect to happen, and what is actually happening?
11+
value: |
12+
**context**
13+
When I do ___.
14+
15+
**expectation**
16+
I expected ___ to occur.
17+
18+
**bug**
19+
But instead ___ happens
20+
Here's an error message I ran into...
21+
22+
```console
23+
$ mdformat README.md
24+
ERROR ...
25+
```
26+
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: reproduce
32+
attributes:
33+
label: Reproduce the bug
34+
description: |
35+
Provide information that others may use to re-produce this behavior.
36+
For example:
37+
38+
- A self-contained command to reproduce the error, e.g.
39+
```console
40+
printf -- '- item A\n - item A.a\n- item B' | pipx run mdformat -
41+
```
42+
- Minimal content of a file that when formatted causes the error. Command to format the file.
43+
44+
placeholder: |
45+
1. Create a file test.md with the content '...'
46+
2. Run `mdformat test.md`
47+
3. See error
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: environment
53+
attributes:
54+
label: List your environment
55+
description: |
56+
List the environment needed to reproduce the error.
57+
Here are a few ideas:
58+
59+
- The output of:
60+
```console
61+
mdformat --version
62+
```
63+
- The version of Python you're using.
64+
- Your operating system
65+
placeholder: |
66+
```
67+
❯ mdformat --version
68+
mdformat 0.7.18 (mdformat_black: 0.1.1)
69+
```
70+
validations:
71+
required: true
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Request an enhancement 💡
2+
description: Suggest an idea for this project
3+
labels: [enhancement]
4+
body:
5+
- type: textarea
6+
id: context
7+
attributes:
8+
label: Context
9+
description: |
10+
- Provide background to help others understand this issue.
11+
- Describe the problem or need you'd like to address.
12+
validations:
13+
required: true
14+
15+
16+
- type: textarea
17+
id: proposal
18+
attributes:
19+
label: Proposal
20+
description: |
21+
- A simple and clear description of what you're proposing.
22+
- Ideas or constraints for how to implement this proposal
23+
- Important considerations to think about or discuss
24+
validations:
25+
required: false

0 commit comments

Comments
 (0)