From 41d61264cab33eef5bc4182ac623b4e3097f58ba Mon Sep 17 00:00:00 2001 From: Wojciech Maj Date: Mon, 22 Nov 2021 12:42:44 +0100 Subject: [PATCH] Replace Markdown issue template with YAML issue forms --- .github/ISSUE_TEMPLATE/Bug_report.md | 40 ------------- .github/ISSUE_TEMPLATE/Bug_report.yml | 66 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.md | 26 --------- .github/ISSUE_TEMPLATE/Feature_request.yml | 38 +++++++++++++ .github/ISSUE_TEMPLATE/Support_question.md | 30 ---------- .github/ISSUE_TEMPLATE/config.yml | 5 ++ 6 files changed, 109 insertions(+), 96 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/Support_question.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md deleted file mode 100644 index 6ca82ef73..000000000 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Something is not working in a way we promised - ---- - -**Before you start - checklist** - - - [ ] I followed instructions in documentation written for my React-PDF version - - [ ] I have checked if this bug is not already reported - - [ ] I have checked if an issue is not listed in [Known issues](https://github.com/wojtekmaj/react-pdf/wiki/Known-issues) - - [ ] If I have a problem with PDF rendering, I checked if my PDF renders properly in Mozilla Firefox - -**Description** - -Short description of the bug you encountered. - -**Steps to reproduce** - -Steps to reproduce the behavior: - -1. Go to '…' -2. Click on '…' -3. Scroll down to '…' -4. See error - -**Expected behavior** - -What you expected to happen? - -**Additional information** - -If applicable, add screenshots (preferably with browser console open) and files you have an issue with to help explain your problem. - -**Environment** - - - Browser (if applicable) [e.g. Chrome 57, Firefox 59]: - - React-PDF version [e.g. 3.0.4]: - - React version [e.g. 16.3.0]: - - Webpack version (if applicable) [e.g. 4.16.2]: diff --git a/.github/ISSUE_TEMPLATE/Bug_report.yml b/.github/ISSUE_TEMPLATE/Bug_report.yml new file mode 100644 index 000000000..624f1ab60 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.yml @@ -0,0 +1,66 @@ +name: 🐛 Bug report +description: Something does not work the way we promised +labels: + - bug +body: + - type: checkboxes + attributes: + label: Before you start - checklist + options: + - label: I followed instructions in documentation written for my React-PDF version + required: true + - label: I have checked if this bug is not already reported + required: true + - label: I have checked if an issue is not listed in [Known issues](https://github.com/wojtekmaj/react-pdf/wiki/Known-issues) + required: true + - label: If I have a problem with PDF rendering, I checked if my PDF renders properly in [PDF.js demo](https://mozilla.github.io/pdf.js/web/viewer.html) + - type: textarea + attributes: + label: Description + description: Short description of the bug you encountered. + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce + description: | + Steps to reproduce the behavior. + + Example: + 1. Go to '…' + 2. Click on '…' + 3. Scroll down to '…' + 4. See error + validations: + required: true + - type: textarea + attributes: + label: Expected behavior + description: What is the expected behavior? + validations: + required: true + - type: textarea + attributes: + label: Actual behavior + description: What is the actual behavior? + validations: + required: true + - type: textarea + attributes: + label: Additional information + description: If applicable, add screenshots (preferably with browser console open) and files you have an issue with to help explain your problem. + - type: textarea + attributes: + label: Environment + description: | + Example: + - **Browser (if applicable)**: Chrome 96, Firefox 94 + - **React-PDF version**: 5.5.0 + - **React version**: 17.0.0 + - **Webpack version (if applicable)**: 5.50.0 + value: | + - **Browser (if applicable)**: + - **React-PDF version**: + - **React version**: + - **Webpack version (if applicable)**: + render: markdown diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md deleted file mode 100644 index 7d673af0e..000000000 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: "\U0001F680 Feature request" -about: I have a great idea for this project - ---- - -**Before you start - checklist** - - - [ ] I understand that React-PDF does not aim to be a fully-fledged PDF viewer and is only a tool to make one - - [ ] I have checked if this feature request is not already reported - -**Is your feature request related to a problem? Please describe.** - -Describe what the problem is. Ex. I'd like to do […] with my PDFs. - -**Describe the solution you'd like** - -What you want to happen? - -**Describe alternatives you've considered** - -Describe alternative solutions or features you've considered, if any. - -**Additional information** - -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 new file mode 100644 index 000000000..dc614640c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.yml @@ -0,0 +1,38 @@ +name: 🚀 Feature request +description: I have a great idea for this project +labels: + - enhancement +body: + - type: checkboxes + attributes: + label: Before you start - checklist + options: + - label: I understand that React-PDF does not aim to be a fully-fledged PDF viewer and is only a tool to make one + required: true + - label: I have checked if this feature request is not already reported + required: true + - type: textarea + attributes: + label: Description + description: | + Describe what the problem is. + + Example: _I'd like to add a feature that […]_ + validations: + required: true + - type: textarea + attributes: + label: Proposed solution + description: | + Describe the solution you'd like. + + Example: + - Add a `foo` flag that, when toggled, enables the feature. + - type: textarea + attributes: + label: Alternatives + description: Describe alternative solutions or features you've considered, if any. + - type: textarea + attributes: + label: Additional information + description: If applicable, add screenshots (preferably with browser console open) and files you have an issue with to help explain your problem. diff --git a/.github/ISSUE_TEMPLATE/Support_question.md b/.github/ISSUE_TEMPLATE/Support_question.md deleted file mode 100644 index 2253645a9..000000000 --- a/.github/ISSUE_TEMPLATE/Support_question.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: "\U0001F914 Support question" -about: I'm stuck with something - ---- - -**Before you start - checklist** - - - [ ] I have read documentation in README - - [ ] I have checked [sample](https://github.com/wojtekmaj/react-pdf/tree/master/sample) and [test](https://github.com/wojtekmaj/react-pdf/tree/master/test) suites to see real life basic implementation - - [ ] I have checked if this question is not already asked - -**What are you trying to achieve? Please describe.** - -Describe what are you trying to achieve Ex. I'd like to display multiple pages of my PDF. - -**Describe solutions you've tried** - -Describe solutions you've already tried, if any. Make sure to include code samples if you're stuck on implementation. - -**Additional information** - -If applicable, add screenshots (preferably with browser console open) and files you have an issue with to help explain your problem. - -**Environment** - - - Browser (if applicable) [e.g. Chrome 57, Firefox 59]: - - React-PDF version [e.g. 3.0.4]: - - React version [e.g. 16.3.0]: - - Webpack version (if applicable) [e.g. 4.16.2]: diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..77ee8c1b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: 🤔 Support question + url: https://stackoverflow.com/questions/tagged/react-pdf + about: This is a bug tracker, not a support forum. For usage questions, please use Discussions (see menu) or Stack Overflow ("Open" button) where there is a lot more people ready to help you out. Thanks!