Skip to content

Commit 3b5b31b

Browse files
committed
Update issue templates with forms
1 parent 91c5930 commit 3b5b31b

File tree

6 files changed

+115
-99
lines changed

6 files changed

+115
-99
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 66 deletions
This file was deleted.
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: 🐛 Bug report
2+
description: Report a reproducible bug or regression in this library.
3+
labels: [bug]
4+
assignees:
5+
- zoontek
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
# Bug report
11+
12+
👋 Hi!
13+
14+
**🚨 Please read the following carefully before opening a new issue 🚨**
15+
*(Your issue may be closed if it doesn't provide the required pieces of information)*
16+
17+
Before submitting a new issue, please:
18+
19+
- Test using the latest release of the library, as maybe your bug has been already fixed.
20+
- Check for possible duplicate issues, with possible answers.
21+
- Check on [reactnative.directory](https://reactnative.directory) if this package supports your target platform (Android, iOS, Expo, …)
22+
23+
Is this still needed? Fill the form 👇
24+
- type: textarea
25+
id: summary
26+
attributes:
27+
label: Bug summary
28+
description: |
29+
Provide a clear and concise description of what the bug is.
30+
If needed, you can also provide other samples: error messages / stack traces, screenshots, gifs, etc.
31+
validations:
32+
required: true
33+
- type: input
34+
id: library-version
35+
attributes:
36+
label: Library version
37+
description: What version of the library are you using?
38+
placeholder: "x.x.x"
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: react-native-info
43+
attributes:
44+
label: Environment info
45+
description: Run `react-native info` in your terminal and paste the results here.
46+
render: shell
47+
validations:
48+
required: true
49+
- type: textarea
50+
id: steps-to-reproduce
51+
attributes:
52+
label: Steps to reproduce
53+
description: |
54+
- You must provide a clear list of steps and code to reproduce the problem.
55+
- 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.
56+
- Is the issue happening on iOS, Android or both?
57+
- Do you run your app on a simulator (which OS version?) or on a physical device (which one? which OS version?)
58+
- If this library has additional install steps, describe them (e.g., pod install? jetify? etc).
59+
- Either re-create the bug using the repository's example app or link to a GitHub repository with code that reproduces the bug.
60+
- Explain the steps we need to take to reproduce the issue:
61+
value: |
62+
1. …
63+
2. …
64+
validations:
65+
required: true
66+
- type: textarea
67+
id: reproducible-sample-code
68+
attributes:
69+
label: Reproducible sample code
70+
description: Please add minimal runnable repro as explained above so that the bug can be tested in isolation.
71+
render: js
72+
validations:
73+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: ➡ Expo issues
4+
url: https://github.com/expo/expo/issues
5+
about: If your issue is specific to usage with Expo, please open it on their repository.
6+
- name: ❓ Stack Overflow
7+
url: https://stackoverflow.com
8+
about: If this library works as promised but you need help, please ask questions there.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: 💡 Feature request
2+
description: Submit your idea for a change in the codebase.
3+
labels: [feature request]
4+
assignees:
5+
- zoontek
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
# Feature request
11+
12+
This issue should serve for you to present or pitch an idea to the maintainers - but remember that it would be better if you were to submit a PR instead 🤗
13+
- type: textarea
14+
id: why-is-this-needed
15+
attributes:
16+
label: Why it is needed?
17+
description: Please tell us a bit more of why you want this feature to be added, what's its origin.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: possible-implementation
22+
attributes:
23+
label: Possible implementation
24+
description: It really helps if you could describe from a technical POV how this new feature would work, which code it rely on, etc.
25+
validations:
26+
required: false
27+
- type: textarea
28+
id: code-sample
29+
attributes:
30+
label: Code sample
31+
description: Please show how the new code could work, if doable.
32+
render: js
33+
validations:
34+
required: false

0 commit comments

Comments
 (0)