Skip to content

Commit

Permalink
Replace Markdown issue template with YAML issue forms
Browse files Browse the repository at this point in the history
  • Loading branch information
wojtekmaj committed Nov 22, 2021
1 parent 6ce7e99 commit 5e59480
Show file tree
Hide file tree
Showing 6 changed files with 152 additions and 96 deletions.
40 changes: 0 additions & 40 deletions .github/ISSUE_TEMPLATE/Bug_report.md

This file was deleted.

66 changes: 66 additions & 0 deletions .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
26 changes: 0 additions & 26 deletions .github/ISSUE_TEMPLATE/Feature_request.md

This file was deleted.

38 changes: 38 additions & 0 deletions .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.
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/Support_question.md

This file was deleted.

48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/Support_question.yml
@@ -0,0 +1,48 @@
name: 🤔 Support question
description: I'm stuck with something
labels:
- question
body:
- type: checkboxes
attributes:
label: Before you start - checklist
options:
- label: I have read documentation in README
required: true
- label: 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
required: true
- label: I have checked if this question is not already asked
required: true
- type: textarea
attributes:
label: Description
description: |
Describe what are you trying to achieve.
Example: _I'd like to display multiple pages of my PDF._
validations:
required: true
- type: textarea
attributes:
label: Solutions you've tried
description: Describe solutions you've already tried, if any. Make sure to include code samples if you're stuck on implementation.
- type: textarea
attributes:
label: Additional information
description: Add any other context or screenshots about the feature request here.
- 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

0 comments on commit 5e59480

Please sign in to comment.