Skip to content

Commit 41d6126

Browse files
committed
Replace Markdown issue template with YAML issue forms
1 parent 6ce7e99 commit 41d6126

File tree

6 files changed

+109
-96
lines changed

6 files changed

+109
-96
lines changed

.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/Bug_report.yml

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: 🐛 Bug report
2+
description: Something does not work the way we promised
3+
labels:
4+
- bug
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Before you start - checklist
9+
options:
10+
- label: I followed instructions in documentation written for my React-PDF version
11+
required: true
12+
- label: I have checked if this bug is not already reported
13+
required: true
14+
- label: I have checked if an issue is not listed in [Known issues](https://github.com/wojtekmaj/react-pdf/wiki/Known-issues)
15+
required: true
16+
- 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)
17+
- type: textarea
18+
attributes:
19+
label: Description
20+
description: Short description of the bug you encountered.
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Steps to reproduce
26+
description: |
27+
Steps to reproduce the behavior.
28+
29+
Example:
30+
1. Go to '…'
31+
2. Click on '…'
32+
3. Scroll down to '…'
33+
4. See error
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: Expected behavior
39+
description: What is the expected behavior?
40+
validations:
41+
required: true
42+
- type: textarea
43+
attributes:
44+
label: Actual behavior
45+
description: What is the actual behavior?
46+
validations:
47+
required: true
48+
- type: textarea
49+
attributes:
50+
label: Additional information
51+
description: If applicable, add screenshots (preferably with browser console open) and files you have an issue with to help explain your problem.
52+
- type: textarea
53+
attributes:
54+
label: Environment
55+
description: |
56+
Example:
57+
- **Browser (if applicable)**: Chrome 96, Firefox 94
58+
- **React-PDF version**: 5.5.0
59+
- **React version**: 17.0.0
60+
- **Webpack version (if applicable)**: 5.50.0
61+
value: |
62+
- **Browser (if applicable)**:
63+
- **React-PDF version**:
64+
- **React version**:
65+
- **Webpack version (if applicable)**:
66+
render: markdown

.github/ISSUE_TEMPLATE/Feature_request.md

Lines changed: 0 additions & 26 deletions
This file was deleted.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 🚀 Feature request
2+
description: I have a great idea for this project
3+
labels:
4+
- enhancement
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Before you start - checklist
9+
options:
10+
- label: I understand that React-PDF does not aim to be a fully-fledged PDF viewer and is only a tool to make one
11+
required: true
12+
- label: I have checked if this feature request is not already reported
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Description
17+
description: |
18+
Describe what the problem is.
19+
20+
Example: _I'd like to add a feature that […]_
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Proposed solution
26+
description: |
27+
Describe the solution you'd like.
28+
29+
Example:
30+
- Add a `foo` flag that, when toggled, enables the feature.
31+
- type: textarea
32+
attributes:
33+
label: Alternatives
34+
description: Describe alternative solutions or features you've considered, if any.
35+
- type: textarea
36+
attributes:
37+
label: Additional information
38+
description: If applicable, add screenshots (preferably with browser console open) and files you have an issue with to help explain your problem.

.github/ISSUE_TEMPLATE/Support_question.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🤔 Support question
4+
url: https://stackoverflow.com/questions/tagged/react-pdf
5+
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!

0 commit comments

Comments
 (0)