Skip to content

Commit 4d49023

Browse files
authored
📚 DOCS improvement (#778)
1 parent 3a6bbb1 commit 4d49023

File tree

4 files changed

+99
-0
lines changed

4 files changed

+99
-0
lines changed
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Bug Report
2+
description: Create a bug report 🐛
3+
labels: ['bug']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thank you for taking the time to file a bug report! Please fill out this form as completely as possible.
8+
- type: input
9+
attributes:
10+
label: What version of `myst-parser` are you using?
11+
description: 'For example: 1.0.0'
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: What version dependencies are you using?
17+
description: 'e.g. for docutils and sphinx'
18+
validations:
19+
required: true
20+
- type: dropdown
21+
id: os
22+
attributes:
23+
label: What operating system are you using?
24+
options:
25+
- Mac
26+
- Windows
27+
- Linux
28+
- Other
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Describe the Bug
34+
description: A clear and concise description of the bug.
35+
validations:
36+
required: true
37+
- type: textarea
38+
attributes:
39+
label: Expected Behavior
40+
description: A clear and concise description of what you expected to happen.
41+
validations:
42+
required: false
43+
- type: textarea
44+
attributes:
45+
label: To Reproduce
46+
description: Steps to reproduce the behavior, please provide clear and concise steps.
47+
validations:
48+
required: false
49+
- type: markdown
50+
attributes:
51+
value: Please ensure the steps you've provided reproduce the issue to the best of your ability.
52+
- type: markdown
53+
attributes:
54+
value: Ideally, maintainers should be able to follow the steps provided in order to reproduce the bug.
55+
- type: markdown
56+
attributes:
57+
value: Thank you for helping out the MyST team, these issues are what makes MyST better!!
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Feature Request
2+
description: Request a new feature ✨
3+
labels: ['enhancement']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thank you for taking the time to submit a feature request! Please fill out this form as completely as possible.
8+
- type: textarea
9+
attributes:
10+
label: Describe the feature you'd like to request
11+
description: A clear and concise description of what you want and what your use case is.
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Describe the solution you'd like
17+
description: A clear and concise description of what you want to happen.
18+
- type: textarea
19+
attributes:
20+
label: Describe alternatives you've considered
21+
description: A clear and concise description of any alternative solutions or features you've considered.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Feature Request
2+
description: Suggest improvements to the documentation 📖
3+
labels: ['documentation']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: Thank you for taking the time to submit a suggestion! Please fill out this form as completely as possible.
8+
- type: textarea
9+
attributes:
10+
label: Describe the gap in the current documentation
11+
description: A clear and concise description of what area is currently missing or unclear.
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Describe the solution you'd like
17+
description: A clear and concise description of what you would like to see in the documentation.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Ask a question 💬
3+
url: https://github.com/executablebooks/MyST-Parser/discussions
4+
about: Ask questions and discuss ideas with other community members

0 commit comments

Comments
 (0)