Skip to content

Commit 2411162

Browse files
authored
feat: add issue templates (#146)
Credit to the author of those templates: @zoontek
1 parent c840402 commit 2411162

File tree

2 files changed

+105
-0
lines changed

2 files changed

+105
-0
lines changed

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: 🐛 Bug report
2+
description: Report a reproducible bug or regression in this library.
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
# Bug report
9+
10+
👋 Hi!
11+
12+
**Please fill the following carefully before opening a new issue ??**
13+
*(Your issue may be closed if it doesn't provide the required pieces of information)*
14+
- type: checkboxes
15+
attributes:
16+
label: Before submitting a new issue
17+
description: Please perform simple checks first.
18+
options:
19+
- label: I tested using the latest version of the library, as the bug might be already fixed.
20+
required: true
21+
- label: I tested using a [supported version](https://github.com/reactwg/react-native-releases/blob/main/docs/support.md) of react native.
22+
required: true
23+
- label: I checked for possible duplicate issues, with possible answers.
24+
required: true
25+
- type: textarea
26+
id: summary
27+
attributes:
28+
label: Bug summary
29+
description: |
30+
Provide a clear and concise description of what the bug is.
31+
If needed, you can also provide other samples: error messages / stack traces, screenshots, gifs, etc.
32+
validations:
33+
required: true
34+
- type: input
35+
id: library-version
36+
attributes:
37+
label: Library version
38+
description: What version of the library are you using?
39+
placeholder: "x.x.x"
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: react-native-info
44+
attributes:
45+
label: Environment info
46+
description: Run `react-native info` in your terminal and paste the results here.
47+
render: shell
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: steps-to-reproduce
52+
attributes:
53+
label: Steps to reproduce
54+
description: |
55+
- You must provide a clear list of steps and code to reproduce the problem.
56+
- Keep the code reproducing the bug as simple as possible, with the minimum amount of code required to reproduce the issue. See https://stackoverflow.com/help/mcve.
57+
- Is the issue happening on iOS, Android or both?
58+
- Do you run your app on a simulator (which OS version?) or on a physical device (which one? which OS version?)
59+
- If this library has additional install steps, describe them (e.g., pod install? jetify? etc).
60+
- Either re-create the bug using the repository's example app or link to a GitHub repository with code that reproduces the bug.
61+
- Explain the steps we need to take to reproduce the issue:
62+
value: |
63+
1. …
64+
2. …
65+
validations:
66+
required: true
67+
- type: textarea
68+
id: reproducible-sample-code
69+
attributes:
70+
label: Reproducible sample code
71+
description: Please add minimal runnable repro as explained above so that the bug can be tested in isolation.
72+
render: js
73+
validations:
74+
required: true
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: 💡Feature request
2+
description: Submit your idea for a change in the codebase.
3+
labels: [feature request]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
# Feature request
9+
10+
- type: textarea
11+
id: why-is-this-needed
12+
attributes:
13+
label: Why it is needed?
14+
description: Please tell us a bit more of why you want this feature to be added, what's its origin.
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: possible-implementation
19+
attributes:
20+
label: Possible implementation
21+
description: It really helps if you could describe from a technical POV how this new feature would work, which code it rely on, etc.
22+
validations:
23+
required: false
24+
- type: textarea
25+
id: code-sample
26+
attributes:
27+
label: Code sample
28+
description: Please show how the new code could work, if doable.
29+
render: js
30+
validations:
31+
required: false

0 commit comments

Comments
 (0)