Skip to content

Commit

Permalink
Create standardized github forms for submitting issues (#2790)
Browse files Browse the repository at this point in the history
  • Loading branch information
carbonrobot authored Feb 8, 2024
1 parent c133086 commit 302e54e
Show file tree
Hide file tree
Showing 7 changed files with 195 additions and 99 deletions.
44 changes: 0 additions & 44 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: Bug report
description: Create a report to help us improve
projects: FormidableLabs/38
labels: ["Type: Bug :bug:"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the sections below.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/FormidableLabs/victory/blob/main/CONTRIBUTING.md#contributor-covenant-code-of-conduct)
options:
- label: I agree to follow this project's Code of Conduct
required: true

- type: input
attributes:
label: Victory version
validations:
required: true

- type: input
attributes:
label: Code Sandbox link
description: |
Please include a code sandbox link or a similar reproduction if possible.
Issues with sandbox links are typically resolved faster.
You can use our preset [here](https://codesandbox.io/s/dj4f7t).
- type: textarea
render: markdown
attributes:
label: Bug report
description: |
A clear and concise description of what the bug is. Please include any
screenshots or code snippets that may help us understand the issue.
validations:
required: true

- type: textarea
render: markdown
attributes:
label: Steps to reproduce
placeholder: |
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
- type: textarea
render: markdown
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.

- type: textarea
render: markdown
attributes:
label: Actual behavior
description: A clear and concise description of what actually happened.

- type: textarea
render: markdown
attributes:
label: Environment
description: |
examples:
- **Device**: Desktop
- **OS**: Ubuntu 20.04
- **Browser**: Chrome
- **Version**: 22
value: |
- Device:
- OS:
- Node:
- npm:
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Feature request
description: Suggest a feature for this project
projects: FormidableLabs/38
labels: ["Type: Enhancement :pencil2:"]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the feature you are requesting.
options:
- label: I have searched the existing issues
required: true

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/FormidableLabs/victory/blob/main/CONTRIBUTING.md#contributor-covenant-code-of-conduct)
options:
- label: I agree to follow this project's Code of Conduct
required: true

- type: textarea
render: markdown
attributes:
label: Feature Request
description: |
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
validations:
required: true
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Question
description: Ask a question about using Victory.
projects: FormidableLabs/38
labels: ["Type: Question :grey_question:"]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the question you have.
options:
- label: I have searched the existing issues
required: true

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/FormidableLabs/victory/blob/main/CONTRIBUTING.md#contributor-covenant-code-of-conduct)
options:
- label: I agree to follow this project's Code of Conduct
required: true

- type: textarea
render: markdown
attributes:
label: Question
description: |
Any background information that might help us answer your questions.
Please include any screenshots or code snippets that may help us understand the issue.
validations:
required: true
35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!--
Have you read Formidable's Code of Conduct? By filing an Issue, you are expected to comply with it, including treating everyone with respect: https://github.com/FormidableLabs/victory-native/blob/main/CONTRIBUTING.md#contributor-covenant-code-of-conduct
-->

### Description

<!-- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. -->

Fixes # (issue)

#### Type of Change

<!-- 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)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

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

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

- [ ] I have included a [changeset](../CONTRIBUTING.md#changesets) if this change will require a version change to one of the packages.
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] I have run `yarn run check` and all checks pass
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] My changes generate no new warnings
- [ ] Any dependent changes have been merged and published in downstream modules
35 changes: 0 additions & 35 deletions ISSUE_TEMPLATE.md

This file was deleted.

0 comments on commit 302e54e

Please sign in to comment.