Skip to content

Commit

Permalink
Merge pull request #1251 from markedjs/issue-templates
Browse files Browse the repository at this point in the history
Update issue templates
  • Loading branch information
joshbruce authored May 15, 2018
2 parents dd10e47 + 4e910c3 commit 3957460
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Bug report
about: Marked says it does this thing but does not

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

<!-- If possible, use the Marked Demo permalink and compare to the CommonMark Dingus permalink to demonstrate the bug -->
<!--
1. [Marked Demo](https://marked.js.org/demo/)
2. [CommonMark Demo](https://spec.commonmark.org/dingus/)
-->

<!-- If you need a specific version and options to reproduce the bug, use the following template -->
<!--
1. Install marked `npm install --save marked@0.3.19` with the version you are using
2. Run marked with input string and options such as `marked('hello *world*', {gfm: true})`
3. Actual output (or error) is...
-->

**Expected behavior**
A clear and concise description of what you expected to happen.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: Feature request
about: Marked doesn't do this thing and I think it should

---

**Describe the feature**
A clear and concise description of what you would like.

**Why is this feature necessary?**
A clear and concise description of why.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/Proposal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Proposal
about: Marked doesn't do this thing and I think it should

---

**What pain point are you perceiving?.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

0 comments on commit 3957460

Please sign in to comment.