Skip to content

Commit 3957460

Browse files
authored
Merge pull request #1251 from markedjs/issue-templates
Update issue templates
2 parents dd10e47 + 4e910c3 commit 3957460

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed

.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Marked says it does this thing but does not
4+
5+
---
6+
7+
**Describe the bug**
8+
A clear and concise description of what the bug is.
9+
10+
**To Reproduce**
11+
Steps to reproduce the behavior:
12+
13+
<!-- If possible, use the Marked Demo permalink and compare to the CommonMark Dingus permalink to demonstrate the bug -->
14+
<!--
15+
1. [Marked Demo](https://marked.js.org/demo/)
16+
2. [CommonMark Demo](https://spec.commonmark.org/dingus/)
17+
-->
18+
19+
<!-- If you need a specific version and options to reproduce the bug, use the following template -->
20+
<!--
21+
1. Install marked `npm install --save [email protected]` with the version you are using
22+
2. Run marked with input string and options such as `marked('hello *world*', {gfm: true})`
23+
3. Actual output (or error) is...
24+
-->
25+
26+
**Expected behavior**
27+
A clear and concise description of what you expected to happen.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Feature request
3+
about: Marked doesn't do this thing and I think it should
4+
5+
---
6+
7+
**Describe the feature**
8+
A clear and concise description of what you would like.
9+
10+
**Why is this feature necessary?**
11+
A clear and concise description of why.
12+
13+
**Describe alternatives you've considered**
14+
A clear and concise description of any alternative solutions or features you've considered.

.github/ISSUE_TEMPLATE/Proposal.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Proposal
3+
about: Marked doesn't do this thing and I think it should
4+
5+
---
6+
7+
**What pain point are you perceiving?.**
8+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
10+
**Describe the solution you'd like**
11+
A clear and concise description of what you want to happen.

0 commit comments

Comments
 (0)