From 8d1853bd3637816c1a74e1dd12d1aecdd0829d1f Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Fri, 11 Jun 2021 09:06:47 -0700 Subject: Fancier issue templates. Based on Doom Emacs's templates. --- .github/ISSUE_TEMPLATE | 11 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 44 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 12 ++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 20 ++++++++++++++ 4 files changed, 76 insertions(+), 11 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml (limited to '.github') diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE deleted file mode 100644 index 83336e684..000000000 --- a/.github/ISSUE_TEMPLATE +++ /dev/null @@ -1,11 +0,0 @@ -Asking a question? -Please use the pandoc-discuss mailing list instead: -https://groups.google.com/forum/#!forum/pandoc-discuss -This tracker is for bug reports and enhancement requests. - -Reporting a bug? -Please include your pandoc version and an example that allows us -to reproduce the problem (complete input, exact command line -used, expected and actual output). The smaller the example, the -better. - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..b3ebc257a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,44 @@ +--- +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/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..48021f86d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,12 @@ +blank_issues_enabled: false +contact_links: + - name: Pandoc User's Guide + url: https://pandoc.org/MANUAL.html + about: "Official manual for pandoc" + - name: pandoc-discuss mailing list + url: https://groups.google.com/forum/#!forum/pandoc-discuss + about: "Discussion forum for pandoc (may be used as an email list)" + - name: Frequently Asked Questions + url: https://pandoc.org/faqs.html + about: "Some frequently asked qusetions (and answers)" + diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..76edc0a5c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,20 @@ +--- +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 + -- cgit v1.2.3