Skip to content

Commit 302e54e

Browse files
authored
Create standardized github forms for submitting issues (#2790)
1 parent c133086 commit 302e54e

7 files changed

+195
-99
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

-44
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
projects: FormidableLabs/38
4+
labels: ["Type: Bug :bug:"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the sections below.
10+
11+
- type: checkboxes
12+
attributes:
13+
label: Is there an existing issue for this?
14+
description: Please search to see if an issue already exists for the bug you encountered.
15+
options:
16+
- label: I have searched the existing issues
17+
required: true
18+
19+
- type: checkboxes
20+
id: terms
21+
attributes:
22+
label: Code of Conduct
23+
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)
24+
options:
25+
- label: I agree to follow this project's Code of Conduct
26+
required: true
27+
28+
- type: input
29+
attributes:
30+
label: Victory version
31+
validations:
32+
required: true
33+
34+
- type: input
35+
attributes:
36+
label: Code Sandbox link
37+
description: |
38+
Please include a code sandbox link or a similar reproduction if possible.
39+
Issues with sandbox links are typically resolved faster.
40+
You can use our preset [here](https://codesandbox.io/s/dj4f7t).
41+
42+
- type: textarea
43+
render: markdown
44+
attributes:
45+
label: Bug report
46+
description: |
47+
A clear and concise description of what the bug is. Please include any
48+
screenshots or code snippets that may help us understand the issue.
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
render: markdown
54+
attributes:
55+
label: Steps to reproduce
56+
placeholder: |
57+
Steps to reproduce the behavior:
58+
1. Go to '...'
59+
2. Click on '....'
60+
3. Scroll down to '....'
61+
4. See error
62+
63+
- type: textarea
64+
render: markdown
65+
attributes:
66+
label: Expected behavior
67+
description: A clear and concise description of what you expected to happen.
68+
69+
- type: textarea
70+
render: markdown
71+
attributes:
72+
label: Actual behavior
73+
description: A clear and concise description of what actually happened.
74+
75+
- type: textarea
76+
render: markdown
77+
attributes:
78+
label: Environment
79+
description: |
80+
examples:
81+
- **Device**: Desktop
82+
- **OS**: Ubuntu 20.04
83+
- **Browser**: Chrome
84+
- **Version**: 22
85+
value: |
86+
- Device:
87+
- OS:
88+
- Node:
89+
- npm:

.github/ISSUE_TEMPLATE/feature_request.md

-20
This file was deleted.
+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Feature request
2+
description: Suggest a feature for this project
3+
projects: FormidableLabs/38
4+
labels: ["Type: Enhancement :pencil2:"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the feature you are requesting.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
14+
- type: checkboxes
15+
id: terms
16+
attributes:
17+
label: Code of Conduct
18+
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)
19+
options:
20+
- label: I agree to follow this project's Code of Conduct
21+
required: true
22+
23+
- type: textarea
24+
render: markdown
25+
attributes:
26+
label: Feature Request
27+
description: |
28+
**Is your feature request related to a problem? Please describe.**
29+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
30+
31+
**Describe the solution you'd like**
32+
A clear and concise description of what you want to happen.
33+
34+
**Describe alternatives you've considered**
35+
A clear and concise description of any alternative solutions or features you've considered.
36+
37+
**Additional context**
38+
Add any other context or screenshots about the feature request here.
39+
validations:
40+
required: true

.github/ISSUE_TEMPLATE/question.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Question
2+
description: Ask a question about using Victory.
3+
projects: FormidableLabs/38
4+
labels: ["Type: Question :grey_question:"]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Is there an existing issue for this?
9+
description: Please search to see if an issue already exists for the question you have.
10+
options:
11+
- label: I have searched the existing issues
12+
required: true
13+
14+
- type: checkboxes
15+
id: terms
16+
attributes:
17+
label: Code of Conduct
18+
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)
19+
options:
20+
- label: I agree to follow this project's Code of Conduct
21+
required: true
22+
23+
- type: textarea
24+
render: markdown
25+
attributes:
26+
label: Question
27+
description: |
28+
Any background information that might help us answer your questions.
29+
Please include any screenshots or code snippets that may help us understand the issue.
30+
validations:
31+
required: true

.github/PULL_REQUEST_TEMPLATE.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!--
2+
3+
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
4+
5+
-->
6+
7+
### Description
8+
9+
<!-- 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. -->
10+
11+
Fixes # (issue)
12+
13+
#### Type of Change
14+
15+
<!-- Please delete options that are not relevant (including this descriptive text). -->
16+
17+
- [ ] Bug fix (non-breaking change which fixes an issue)
18+
- [ ] New feature (non-breaking change which adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
20+
- [ ] This change requires a documentation update
21+
22+
### How Has This Been Tested?
23+
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. -->
25+
26+
### Checklist: (Feel free to delete this section upon completion)
27+
28+
- [ ] I have included a [changeset](../CONTRIBUTING.md#changesets) if this change will require a version change to one of the packages.
29+
- [ ] I have performed a self-review of my own code
30+
- [ ] I have commented my code, particularly in hard-to-understand areas
31+
- [ ] I have made corresponding changes to the documentation
32+
- [ ] I have run `yarn run check` and all checks pass
33+
- [ ] I have added tests that prove my fix is effective or that my feature works
34+
- [ ] My changes generate no new warnings
35+
- [ ] Any dependent changes have been merged and published in downstream modules

ISSUE_TEMPLATE.md

-35
This file was deleted.

0 commit comments

Comments
 (0)