Skip to content

Commit 0ee44a7

Browse files
authored
chore: clean up issue and PR templates (#1223)
1 parent cd49848 commit 0ee44a7

File tree

4 files changed

+24
-16
lines changed

4 files changed

+24
-16
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,34 +11,42 @@ Have you read Formidable's Code of Conduct? By filing an Issue, you are expected
1111

1212
### Prerequisites
1313

14-
**Feel free to delete this section if you have checked off all of the following.**
14+
<!-- Feel free to delete this section if you have checked off all of the following: -->
1515

16-
- [ ] I've searched open [issues](https://www.github.com/FormidableLabs/spectacle/issues) to make sure I'm not opening a duplicate issue
16+
- [ ] I have searched the open [issues](https://www.github.com/FormidableLabs/spectacle/issues) to make sure I'm not opening a duplicate issue
1717
- [ ] I have read through the [docs](https://www.formidable.com/open-source/spectacle/docs) before asking a question
1818
- [ ] I am using the latest version of Spectacle
1919

2020
### Describe Your Environment
2121

22-
What version of Spectacle are you using? (can be found by running `npm list spectacle`)
22+
**What version of Spectacle are you using?** (can be found by running `npm list --depth 0 spectacle`)
2323

24-
What version of React are you using? (can be found by running `npm list react`)
24+
**What version of React are you using?** (can be found by running `npm list --depth 0 react`)
2525

26-
What browser are you using?
26+
**What browser are you using?** (e.g., Chrome 105.0.5195.102, Safari 16.0)
2727

28-
What machine are you on?
28+
**What platform are you on?** (e.g., Windows, macOS, iOS, Android)
2929

3030
### Describe the Problem
3131

32+
<!--
33+
3234
It's easier to show us than tell us what's going wrong with your code. Because of this, we ask that you do one of three things to help us reproduce the bug:
3335
34-
1. Create a public minimal repository that we can `git clone`, with install + error reproduction steps in the README.
35-
2. Fork our [simple Spectacle sample Sandbox](https://codesandbox.io/s/simple-spectacle-example-3jebu), reproduce your issue in the code, and paste the link here.
36+
1. Fork one of the codesandbox examples below, reproduce your issue in the code, and paste the link in this section.
37+
Simple Spectacle Example:
38+
https://codesandbox.io/s/lq1tbm
39+
TypeScript version:
40+
https://codesandbox.io/s/kqotzi
41+
2. Create a public minimal repository that we can `git clone`, with install + error reproduction steps in the README.
3642
3. Open up a PR, include "WIP" and the Issue # in the title, and point us to the failing regression tests.
3743
44+
-->
45+
3846
**Expected behavior:** [What you expect to happen]
3947

4048
**Actual behavior:** [What actually happens]
4149

4250
### Additional Information
4351

44-
Any additional information, configuration or data that might be necessary to reproduce the issue.
52+
<!-- Any additional information, configuration or data that might be necessary to reproduce the issue. -->

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ Have you read Formidable's Code of Conduct? By filing an Issue, you are expected
1111

1212
### Description
1313

14-
Including the problem you want to address, use cases, benefits, and/or goals.
14+
<!-- Including the problem you want to address, use cases, benefits, and/or goals. -->
1515

1616
### Proposal
1717

18-
How do you propose we implement this change?
18+
<!-- How do you propose we implement this change? -->
1919

2020
### Links / References
2121

22-
Any resources you want to point to for reference or more information.
22+
<!-- Any resources you want to point to for reference or more information. -->

.github/ISSUE_TEMPLATE/question.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Have you read Formidable's Code of Conduct? By filing an Issue, you are expected
1111

1212
### Question
1313

14-
What question do you have about using Spectacle?
14+
<!-- What question do you have about using Spectacle? -->
1515

1616
### Background Info/Attempts
1717

18-
Any background information that might help us answer your questions, or a code snippet or link to a code example if you have an implementation question.
18+
<!-- Any background information that might help us answer your questions, or a code snippet or link to a code example (e.g., using codesandbox.io/s/lq1tbm) if you have an implementation question. -->

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Fixes # (issue)
1212

1313
#### Type of Change
1414

15-
Please delete options that are not relevant (including this descriptive text).
15+
<!-- Please delete options that are not relevant (including this descriptive text). -->
1616

1717
- [ ] Bug fix (non-breaking change which fixes an issue)
1818
- [ ] New feature (non-breaking change which adds functionality)
@@ -21,7 +21,7 @@ Please delete options that are not relevant (including this descriptive text).
2121

2222
### How Has This Been Tested?
2323

24-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
24+
<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration. -->
2525

2626
### Checklist: (Feel free to delete this section upon completion)
2727

0 commit comments

Comments
 (0)