aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorJohn MacFarlane <jgm@berkeley.edu>2021-06-11 09:37:27 -0700
committerJohn MacFarlane <jgm@berkeley.edu>2021-06-11 09:37:27 -0700
commit6d471a4a2803de1831ad09ae0df55e197e026ea3 (patch)
treedde74c4536438a25ed929b384639dbdd46721e6a /.github
parentd46e0551fe988e4d3bc18a2364e1c53e0289bbe6 (diff)
downloadpandoc-6d471a4a2803de1831ad09ae0df55e197e026ea3.tar.gz
Improve issue templates.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md35
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml44
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md16
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.yml20
4 files changed, 17 insertions, 98 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index dd84ea782..8b2f40bcb 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -2,37 +2,20 @@
name: Bug report
about: Create a report to help us improve
title: ''
-labels: ''
+labels: 'bug'
assignees: ''
---
-**Describe the bug**
-A clear and concise description of what the bug is.
+Thank you for reporting an issue! Before you continue, please make sure that you have
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+- [ ] searched [the issue tracker](https://github.com/jgm/pandoc/issues) for similar issues (the closed issues too)
+- [ ] searched [pandoc-discuss](https://groups.google.com/forum/#!forum/pandoc-discuss) for solutions
+- [ ] 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)
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+**Explain the problem.**
+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.
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Pandoc version?**
+What version of pandoc are you using (`pandoc --version`), on what OS?
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
deleted file mode 100644
index b3ebc257a..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ /dev/null
@@ -1,44 +0,0 @@
----
-name: 📝 Bug Report
-description: Report a bug, error, or misbehavior
-title: "Briefly summarize your issue here"
-labels: ["bug"]
-body:
-- type: markdown
- attributes:
- value: |
- **Thank you for reporting an issue to our issue tracker!**
- Before you proceed, please consult our available resources and collect as much information about your issue as possible:
-
-- type: checkboxes
- attributes:
- options:
- - label: I have searched [the manual](https://pandoc.org/MANUAL.html) for solutions.
- required: true
- - label: I have searched [the FAQs](https://pandoc.org/faqs.html) for solutions.
- required: true
- - label: I have searched [the issue tracker](https://github.com/jgm/pandoc/issues) for similar issues (the closed issues too).
- required: true
- - label: I have searched [pandoc-discuss](https://groups.google.com/forum/#!forum/pandoc-discuss) for solutions.
- required: true
- - 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).
- required: true
- - label: If reporting a behavior change, I have searched the [changelog](https://github.com/jgm/pandoc/changelog.md) to see if it was intentional.
- required: true
-- type: textarea
- attributes:
- label: Explain how to reproduce the problem.
- description: |
- + Please give as minimal an example as you can to reproduce the issue.
- + Include full command line and all files necessary to reproduce.
- validations:
- required: true
-- type: textarea
- attributes:
- label: What happened, and what did you expect to happen?
-- type: textarea
- attributes:
- label: What pandoc version did you use? (`pandoc --version`)
- validations:
- required: true
-
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index bbcbbe7d6..f64c097c7 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -2,19 +2,19 @@
name: Feature request
about: Suggest an idea for this project
title: ''
-labels: ''
+labels: 'enhancement'
assignees: ''
---
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+Thank you for suggesting a fetaure! Before you continue, please make sure that you have
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+- [ ] read the [contributing guidelines](https://github.com/jgm/pandoc/CONTRIBUTING.md)
+- [ ] searched [the issue tracker](https://github.com/jgm/pandoc/issues) for similar issues (the closed issues too)
+- [ ] searched [pandoc-discuss](https://groups.google.com/forum/#!forum/pandoc-discuss) for relevant discussions
+- [ ] searched the [changelog](https://github.com/jgm/pandoc/changelog.md) to make sure the feature has not already been implemented.
+
+**Describe your proposed improvement and the problem it solves.**
**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-**Additional context**
-Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
deleted file mode 100644
index 76edc0a5c..000000000
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ /dev/null
@@ -1,20 +0,0 @@
----
-name: 📝 Feature Request
-description: Propose a new idea or feature
-title: "Briefly summarize your request here"
-labels: ["enhancement"]
-body:
-- type: checkboxes
- attributes:
- options:
- - label: I have read the [contributing guide](https://github.com/jgm/CONTRIBUTING.md).
- required: true
- - label: I have searched [the issue tracker](https://github.com/jgm/pandoc/issues) (including closed issues) for similar requests.
- required: true
- - label: I have searched [the pandoc-discuss mailing list](https://groups.google.com/forum/#!forum/pandoc-discuss) for relevant discussions.
- required: true
-- type: textarea
- attributes:
- label: Describe your request
- required: true
-