Skip to content

Clean up issue and PR templates #1223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fritz-c merged 1 commit into from
Sep 19, 2022
Merged

Clean up issue and PR templates #1223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,34 +11,42 @@ Have you read Formidable's Code of Conduct? By filing an Issue, you are expected

### Prerequisites

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

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

### Describe Your Environment

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

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

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

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

### Describe the Problem

<!--

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:

1. Create a public minimal repository that we can `git clone`, with install + error reproduction steps in the README.
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.
1. Fork one of the codesandbox examples below, reproduce your issue in the code, and paste the link in this section.
Simple Spectacle Example:
https://codesandbox.io/s/lq1tbm
TypeScript version:
https://codesandbox.io/s/kqotzi
2. Create a public minimal repository that we can `git clone`, with install + error reproduction steps in the README.
3. Open up a PR, include "WIP" and the Issue # in the title, and point us to the failing regression tests.

-->

**Expected behavior:** [What you expect to happen]

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

### Additional Information

Any additional information, configuration or data that might be necessary to reproduce the issue.
<!-- Any additional information, configuration or data that might be necessary to reproduce the issue. -->
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ Have you read Formidable's Code of Conduct? By filing an Issue, you are expected

### Description

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

### Proposal

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

### Links / References

Any resources you want to point to for reference or more information.
<!-- Any resources you want to point to for reference or more information. -->
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/question.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Have you read Formidable's Code of Conduct? By filing an Issue, you are expected

### Question

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

### Background Info/Attempts

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.
<!-- 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. -->
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Fixes # (issue)

#### Type of Change

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

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

### How Has This Been Tested?

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.
<!-- 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. -->

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

Expand Down