Skip to content

Commit e146728

Browse files
📚 Update docs (#285)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 4c3a34d commit e146728

File tree

3 files changed

+111
-0
lines changed

3 files changed

+111
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Report a problem 🐛
2+
description: Problem reports are for when something behaves incorrectly, or differently from how you'd expect.
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+
12+
If possible, provide screenshots or error messages that you've encountered.
13+
value: |
14+
**context**
15+
When I do ___.
16+
17+
**expectation**
18+
I expected ___ to occur.
19+
20+
**bug**
21+
But instead ___ happens
22+
Here's an error message I ran into...
23+
24+
**problem**
25+
This is a problem for people doing ___ because ___.
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+
- Step-by-step instructions that others can follow.
39+
- Links to a website that demonstrates the bug.
40+
- Information about certain conditions that the bug pops up.
41+
42+
placeholder: |
43+
1. Go to '...'
44+
2. Click on '....'
45+
3. Scroll down to '....'
46+
4. See error
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: environment
52+
attributes:
53+
label: List your environment
54+
description: |
55+
List the environment needed to reproduce the error.
56+
Here are a few ideas:
57+
58+
- Version of markdown-it-py
59+
- Versions of mdit-py-plugins
60+
- The version of Python you're using.
61+
- Your operating system
62+
validations:
63+
required: false

.github/ISSUE_TEMPLATE/config.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: Questions or general discussion ❓🗣️
3+
url: https://github.com/executablebooks/markdown-it-py/discussions
4+
about: Use Disussions for general conversations that aren't meant for actionable Issues.
+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Request an enhancement 💡
2+
description: Suggest an idea for this project
3+
labels: [enhancement]
4+
body:
5+
6+
- type: textarea
7+
id: context
8+
attributes:
9+
label: Context
10+
description: |
11+
- Provide background to help others understand this issue.
12+
- Describe the problem or need you'd like to address.
13+
validations:
14+
required: true
15+
16+
17+
- type: textarea
18+
id: proposal
19+
attributes:
20+
label: Proposal
21+
description: |
22+
- A simple and clear description of what you're proposing.
23+
- Ideas or constraints for how to implement this proposal
24+
- Important considerations to think about or discuss
25+
validations:
26+
required: false
27+
28+
29+
- type: textarea
30+
id: tasks
31+
attributes:
32+
label: Tasks and updates
33+
description: |
34+
Use this area to track ongoing work and to-do items.
35+
The more specific the better.
36+
37+
_If you can't think of anything then just leave this blank and we can fill it in later! This can be filled in as we understand more about an issue._
38+
39+
placeholder: |
40+
- [ ] Discuss and decide on what to do...
41+
- [ ] Implement partial feature A...
42+
43+
validations:
44+
required: false

0 commit comments

Comments
 (0)