git.iko.soy/typeable/pandoc
on master help sign in
Improve issue templates.
commit6d471a4a2803de1831ad09ae0df55e197e026ea3 authorJohn MacFarlane <jgm@berkeley.edu> dateFri 11 Jun 2021, 09:37 (5 years ago) parentd46e055
4 files changed+17−98
.github/ISSUE_TEMPLATE/bug_report.md+9−26 .github/ISSUE_TEMPLATE/bug_report.yml−44 .github/ISSUE_TEMPLATE/feature_request.md+8−8 .github/ISSUE_TEMPLATE/feature_request.yml−20
.github/ISSUE_TEMPLATE/bug_report.md+9−26
@@ -2,37 +2,20 @@
22name: Bug report
33about: Create a report to help us improve
44title: ''
5−labels: ''
5+labels: 'bug'
66assignees: ''
77
88---
99
10−**Describe the bug**
11−A clear and concise description of what the bug is.
10+Thank you for reporting an issue! Before you continue, please make sure that you have
1211
13−**To Reproduce**
14−Steps to reproduce the behavior:
15−1. Go to '...'
16−2. Click on '....'
17−3. Scroll down to '....'
18−4. See error
12+- [ ] searched [the issue tracker](https://github.com/jgm/pandoc/issues) for similar issues (the closed issues too)
13+- [ ] searched [pandoc-discuss](https://groups.google.com/forum/#!forum/pandoc-discuss) for solutions
14+- [ ] reproduced your issue on [the latest release](https://github.com/jgm/pandoc/releases) doom-emacs/commit) of pandoc, or on [try pandoc](https://pandoc.org/try)
1915
20−**Expected behavior**
21−A clear and concise description of what you expected to happen.
16+**Explain the problem.**
17+Include the exact command line you used and all inputs necessary to reproduce the issue. Please create as minimal an example as possible, to help the maintainers isolate the problem. Explain the output you received and how it differs from what you expected.
2218
23−**Screenshots**
24−If applicable, add screenshots to help explain your problem.
19+**Pandoc version?**
20+What version of pandoc are you using (`pandoc --version`), on what OS?
2521
26−**Desktop (please complete the following information):**
27− - OS: [e.g. iOS]
28− - Browser [e.g. chrome, safari]
29− - Version [e.g. 22]
30−
31−**Smartphone (please complete the following information):**
32− - Device: [e.g. iPhone6]
33− - OS: [e.g. iOS8.1]
34− - Browser [e.g. stock browser, safari]
35− - Version [e.g. 22]
36−
37−**Additional context**
38−Add any other context about the problem here.
.github/ISSUE_TEMPLATE/bug_report.ymldeleted−44
@@ -1,44 +0,0 @@
1−---
2−name: 📝 Bug Report
3−description: Report a bug, error, or misbehavior
4−title: "Briefly summarize your issue here"
5−labels: ["bug"]
6−body:
7−- type: markdown
8− attributes:
9− value: |
10− **Thank you for reporting an issue to our issue tracker!**
11− Before you proceed, please consult our available resources and collect as much information about your issue as possible:
12−
13−- type: checkboxes
14− attributes:
15− options:
16− - label: I have searched [the manual](https://pandoc.org/MANUAL.html) for solutions.
17− required: true
18− - label: I have searched [the FAQs](https://pandoc.org/faqs.html) for solutions.
19− required: true
20− - label: I have searched [the issue tracker](https://github.com/jgm/pandoc/issues) for similar issues (the closed issues too).
21− required: true
22− - label: I have searched [pandoc-discuss](https://groups.google.com/forum/#!forum/pandoc-discuss) for solutions.
23− required: true
24− - label: I can reproduce my issue on [the latest release](https://github.com/jgm/pandoc/releases) doom-emacs/commit) of pandoc, or on [try pandoc](https://pandoc.org/try).
25− required: true
26− - label: If reporting a behavior change, I have searched the [changelog](https://github.com/jgm/pandoc/changelog.md) to see if it was intentional.
27− required: true
28−- type: textarea
29− attributes:
30− label: Explain how to reproduce the problem.
31− description: |
32− + Please give as minimal an example as you can to reproduce the issue.
33− + Include full command line and all files necessary to reproduce.
34− validations:
35− required: true
36−- type: textarea
37− attributes:
38− label: What happened, and what did you expect to happen?
39−- type: textarea
40− attributes:
41− label: What pandoc version did you use? (`pandoc --version`)
42− validations:
43− required: true
44−
.github/ISSUE_TEMPLATE/feature_request.md+8−8
@@ -2,19 +2,19 @@
22name: Feature request
33about: Suggest an idea for this project
44title: ''
5−labels: ''
5+labels: 'enhancement'
66assignees: ''
77
88---
99
10−**Is your feature request related to a problem? Please describe.**
11−A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
10+Thank you for suggesting a fetaure! Before you continue, please make sure that you have
1211
13−**Describe the solution you'd like**
14−A clear and concise description of what you want to happen.
12+- [ ] read the [contributing guidelines](https://github.com/jgm/pandoc/CONTRIBUTING.md)
13+- [ ] searched [the issue tracker](https://github.com/jgm/pandoc/issues) for similar issues (the closed issues too)
14+- [ ] searched [pandoc-discuss](https://groups.google.com/forum/#!forum/pandoc-discuss) for relevant discussions
15+- [ ] searched the [changelog](https://github.com/jgm/pandoc/changelog.md) to make sure the feature has not already been implemented.
16+
17+**Describe your proposed improvement and the problem it solves.**
1518
1619**Describe alternatives you've considered**
17−A clear and concise description of any alternative solutions or features you've considered.
1820
19−**Additional context**
20−Add any other context or screenshots about the feature request here.
.github/ISSUE_TEMPLATE/feature_request.ymldeleted−20
@@ -1,20 +0,0 @@
1−---
2−name: 📝 Feature Request
3−description: Propose a new idea or feature
4−title: "Briefly summarize your request here"
5−labels: ["enhancement"]
6−body:
7−- type: checkboxes
8− attributes:
9− options:
10− - label: I have read the [contributing guide](https://github.com/jgm/CONTRIBUTING.md).
11− required: true
12− - label: I have searched [the issue tracker](https://github.com/jgm/pandoc/issues) (including closed issues) for similar requests.
13− required: true
14− - label: I have searched [the pandoc-discuss mailing list](https://groups.google.com/forum/#!forum/pandoc-discuss) for relevant discussions.
15− required: true
16−- type: textarea
17− attributes:
18− label: Describe your request
19− required: true
20−