chore: update templates (#1775)
This commit is contained in:
parent
cdaf80a489
commit
1aba5689a9
6
.github/ISSUE_TEMPLATE.md
vendored
6
.github/ISSUE_TEMPLATE.md
vendored
@ -2,9 +2,9 @@
|
||||
|
||||
**Markdown flavor:** Markdown.pl|CommonMark|GitHub Flavored Markdown|n/a
|
||||
|
||||
<!-- The NPM version or commit hash having the issue -->
|
||||
<!-- The NPM version or commit hash having the issue -->
|
||||
|
||||
<!--
|
||||
<!--
|
||||
|
||||
If submitting something other than a defect with Marked itself, please use the following:
|
||||
|
||||
@ -34,7 +34,7 @@
|
||||
|
||||
<!-- Describe what code combination got you there -->
|
||||
|
||||
<!--
|
||||
<!--
|
||||
If error is thrown add the following:
|
||||
|
||||
## Call stack & console log
|
||||
|
55
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
55
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
@ -1,27 +1,28 @@
|
||||
---
|
||||
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.
|
||||
---
|
||||
name: Bug report
|
||||
about: Marked says it does this thing but does not
|
||||
|
||||
---
|
||||
**Marked version:**
|
||||
|
||||
**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.
|
||||
|
28
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
28
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
@ -1,14 +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.
|
||||
---
|
||||
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.
|
||||
|
6
.github/ISSUE_TEMPLATE/Proposal.md
vendored
6
.github/ISSUE_TEMPLATE/Proposal.md
vendored
@ -1,11 +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.
|
||||
|
6
.github/PULL_REQUEST_TEMPLATE/badges.md
vendored
6
.github/PULL_REQUEST_TEMPLATE/badges.md
vendored
@ -6,9 +6,9 @@
|
||||
- [ ] Add a badge
|
||||
- [ ] Remove a badge
|
||||
|
||||
<!--
|
||||
<!--
|
||||
|
||||
Explain your reasoning behind tagging that person.
|
||||
Explain your reasoning behind tagging that person.
|
||||
|
||||
Preferably by citing objective examples, like PRs, Issues, and so on.
|
||||
|
||||
@ -47,4 +47,4 @@ within 30 days, if you have not indicated which option you are taking one of the
|
||||
|
||||
-->
|
||||
|
||||
Note: All committers must approve via review before merging, the disapproving committer can simply close the PR.
|
||||
Note: All committers must approve via review before merging, the disapproving committer can simply close the PR.
|
||||
|
Loading…
x
Reference in New Issue
Block a user