Skip to content

Commit 42f4006

Browse files
jakmrojakmro
authored
Add templates for bug reports, feature requests and pull requests (#30)
1 parent 653ca0b commit 42f4006

File tree

3 files changed

+246
-0
lines changed

3 files changed

+246
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
name: 🐛 Bug report
2+
description: Report an issue with React Native ExecuTorch here.
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thanks for taking the time to fill out this bug report!
8+
9+
Before you proceed:
10+
11+
- Make sure to check whether there are similar issues in the repository
12+
- Make sure to clean cache in your project. Depending on your setup this could be done by:
13+
- `yarn start --reset-cache` or
14+
- `npm start -- --reset-cache` or
15+
- `expo start --clear`
16+
17+
- type: markdown
18+
attributes:
19+
value: |
20+
## Required information
21+
- type: textarea
22+
id: description
23+
attributes:
24+
label: Description
25+
description: Please provide a clear, concise and descriptive explanation of what the bug is. Include screenshots or a video if needed. Tell us what were you expecting to happen instead of what is happening now.
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: steps-to-reproduce
31+
attributes:
32+
label: Steps to reproduce
33+
description: Provide a detailed list of steps that reproduce the issue.
34+
placeholder: |
35+
1.
36+
2.
37+
3.
38+
validations:
39+
required: true
40+
41+
- type: input
42+
id: repro
43+
attributes:
44+
label: Snack or a link to a repository
45+
description: |
46+
Please provide a Snack (https://snack.expo.io/) or a link to a repository on GitHub under your username that reproduces the issue.
47+
Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve.
48+
Issues without a reproduction are likely to stale.
49+
placeholder: Link to a Snack or a GitHub repository
50+
validations:
51+
required: true
52+
53+
- type: input
54+
id: react-native-executorch-version
55+
attributes:
56+
label: React Native Executorch version
57+
description: What version of react-native-executorch are you using?
58+
placeholder: 0.1.1
59+
validations:
60+
required: true
61+
62+
- type: input
63+
id: react-native-version
64+
attributes:
65+
label: React Native version
66+
description: What version of react-native are you using?
67+
placeholder: 0.73.1
68+
validations:
69+
required: true
70+
71+
- type: dropdown
72+
id: platforms
73+
attributes:
74+
label: Platforms
75+
description: On what platform your application is running on?
76+
multiple: true
77+
options:
78+
- Android
79+
- iOS
80+
validations:
81+
required: true
82+
83+
- type: markdown
84+
attributes:
85+
value: |
86+
## Additonal information
87+
88+
Providing as much information as possible greatly helps us with reproducting the issues.
89+
90+
- type: dropdown
91+
id: runtime
92+
attributes:
93+
label: JavaScript runtime
94+
description: What runtime is your application using?
95+
options:
96+
- JSC
97+
- Hermes
98+
- V8
99+
100+
- type: dropdown
101+
id: workflow
102+
attributes:
103+
label: Workflow
104+
description: How is your application managed?
105+
options:
106+
- React Native
107+
- Expo Go
108+
- Expo Dev Client
109+
110+
- type: dropdown
111+
id: architecture
112+
attributes:
113+
label: Architecture
114+
description: What React Native architecture your application is running on?
115+
options:
116+
- Paper (Old Architecture)
117+
- Fabric (New Architecture)
118+
119+
- type: dropdown
120+
id: build-type
121+
attributes:
122+
label: Build type
123+
description: What mode your application is running?
124+
options:
125+
- Debug mode
126+
- Release mode
127+
128+
- type: dropdown
129+
id: emulator
130+
attributes:
131+
label: Device
132+
description: How are you running your application?
133+
options:
134+
- iOS simulator
135+
- Android emulator
136+
- Real device
137+
138+
- type: input
139+
id: device-model
140+
attributes:
141+
label: Device model
142+
description: What device you are experiencing this problem on? Specify full device name along with the version of the operating system it's running.
143+
placeholder: ex. Samsung Galaxy A22 (Android 12)
144+
145+
- type: input
146+
id: ai-model
147+
attributes:
148+
label: AI model
149+
description: What AI models are you using?
150+
placeholder: ex. Llama 3.2 1B QLoRA, Llama 3.2 3B SpinQuant
151+
152+
- type: textarea
153+
id: performance
154+
attributes:
155+
label: Performance logs
156+
description: Please provide performance logs, e.g., CPU, memory usage. Include screenshots or a video if needed.
157+
158+
- type: dropdown
159+
id: acknowledgements
160+
attributes:
161+
label: Acknowledgements
162+
description: I searched for similar issues in the repository.
163+
options:
164+
- 'Yes'
165+
validations:
166+
required: true

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: 🚀 Feature request
2+
description: Propose a new idea or improvement for the React Native ExecuTorch
3+
body:
4+
- type: textarea
5+
id: problem_description
6+
attributes:
7+
label: Problem description
8+
description: >
9+
Provide a detailed explanation of the issue or need you are experiencing.
10+
Please describe the problem clearly and concisely.
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: solution_description
16+
attributes:
17+
label: Proposed solution
18+
description: >
19+
Offer a detailed description of your proposed solution or feature enhancement.
20+
Explain what changes or additions you would like to see implemented.
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: alternative_solutions
26+
attributes:
27+
label: Alternative solutions
28+
description: >
29+
List any alternative solutions or features you have considered.
30+
Explain why these alternatives are not your preferred choice.
31+
validations:
32+
required: false
33+
34+
- type: textarea
35+
id: benefit_description
36+
attributes:
37+
label: Benefits to React Native ExecuTorch
38+
description: >
39+
Describe how this feature will enhance the library's capabilities.
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: additional_context
45+
attributes:
46+
label: Additional context
47+
description: >
48+
Add any other relevant context, code examples, or screenshots that should be considered.
49+
validations:
50+
required: false

‎.github/pull_request_template.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Description
2+
<!-- Provide a concise and descriptive summary of the changes implemented in this PR. -->
3+
4+
### Type of change
5+
- [ ] Bug fix (non-breaking change which fixes an issue)
6+
- [ ] New feature (non-breaking change which adds functionality)
7+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
8+
- [ ] Documentation update (improves or adds clarity to existing documentation)
9+
10+
### Tested on
11+
- [ ] iOS
12+
- [ ] Android
13+
14+
### Testing instructions
15+
<!-- Provide step-by-step instructions on how to test your changes. Include setup details if necessary. -->
16+
17+
### Screenshots
18+
<!-- Add screenshots here, if applicable -->
19+
20+
### Related issues
21+
<!-- Link related issues here using #issue-number -->
22+
23+
### Checklist
24+
- [ ] I have performed a self-review of my code
25+
- [ ] I have commented my code, particularly in hard-to-understand areas
26+
- [ ] I have updated the documentation accordingly
27+
- [ ] My changes generate no new warnings
28+
29+
### Additional notes
30+
<!-- Include any additional information, assumptions, or context that reviewers might need to understand this PR. -->

0 commit comments

Comments
 (0)