Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add templates for bug reports, feature requests and pull requests #30

Merged
merged 3 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
166 changes: 166 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
name: 🐛 Bug report
description: Report an issue with React Native ExecuTorch here.
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!

Before you proceed:

- Make sure to check whether there are similar issues in the repository
- Make sure to clean cache in your project. Depending on your setup this could be done by:
- `yarn start --reset-cache` or
- `npm start -- --reset-cache` or
- `expo start --clear`

- type: markdown
attributes:
value: |
## Required information
- type: textarea
id: description
attributes:
label: Description
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.
validations:
required: true

- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: Provide a detailed list of steps that reproduce the issue.
placeholder: |
1.
2.
3.
validations:
required: true

- type: input
id: repro
attributes:
label: Snack or a link to a repository
description: |
Please provide a Snack (https://snack.expo.io/) or a link to a repository on GitHub under your username that reproduces the issue.
Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve.
Issues without a reproduction are likely to stale.
placeholder: Link to a Snack or a GitHub repository
validations:
required: true

- type: input
id: react-native-executorch-version
attributes:
label: React Native Executorch version
description: What version of react-native-executorch are you using?
placeholder: 0.1.1
validations:
required: true

- type: input
id: react-native-version
attributes:
label: React Native version
description: What version of react-native are you using?
placeholder: 0.73.1
validations:
required: true

- type: dropdown
id: platforms
attributes:
label: Platforms
description: On what platform your application is running on?
multiple: true
options:
- Android
- iOS
validations:
required: true

- type: markdown
attributes:
value: |
## Additonal information

Providing as much information as possible greatly helps us with reproducting the issues.

- type: dropdown
id: runtime
attributes:
label: JavaScript runtime
description: What runtime is your application using?
options:
- JSC
- Hermes
- V8

- type: dropdown
id: workflow
attributes:
label: Workflow
description: How is your application managed?
options:
- React Native
- Expo Go
- Expo Dev Client

- type: dropdown
id: architecture
attributes:
label: Architecture
description: What React Native architecture your application is running on?
options:
- Paper (Old Architecture)
- Fabric (New Architecture)

- type: dropdown
id: build-type
attributes:
label: Build type
description: What mode your application is running?
options:
- Debug mode
- Release mode

- type: dropdown
id: emulator
attributes:
label: Device
description: How are you running your application?
options:
- iOS simulator
- Android emulator
- Real device

- type: input
id: device-model
attributes:
label: Device model
description: What device you are experiencing this problem on? Specify full device name along with the version of the operating system it's running.
placeholder: ex. Samsung Galaxy A22 (Android 12)

- type: input
id: ai-model
attributes:
label: AI model
description: What AI models are you using?
placeholder: ex. Llama 3.2 1B QLoRA, Llama 3.2 3B SpinQuant

- type: textarea
id: performance
attributes:
label: Performance logs
description: Please provide performance logs, e.g., CPU, memory usage. Include screenshots or a video if needed.

- type: dropdown
id: acknowledgements
attributes:
label: Acknowledgements
description: I searched for similar issues in the repository.
options:
- 'Yes'
validations:
required: true
50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: 🚀 Feature request
description: Propose a new idea or improvement for the React Native ExecuTorch
body:
- type: textarea
id: problem_description
attributes:
label: Problem description
description: >
Provide a detailed explanation of the issue or need you are experiencing.
Please describe the problem clearly and concisely.
validations:
required: true

- type: textarea
id: solution_description
attributes:
label: Proposed solution
description: >
Offer a detailed description of your proposed solution or feature enhancement.
Explain what changes or additions you would like to see implemented.
validations:
required: true

- type: textarea
id: alternative_solutions
attributes:
label: Alternative solutions
description: >
List any alternative solutions or features you have considered.
Explain why these alternatives are not your preferred choice.
validations:
required: false

- type: textarea
id: benefit_description
attributes:
label: Benefits to React Native ExecuTorch
description: >
Describe how this feature will enhance the library's capabilities.
validations:
required: true

- type: textarea
id: additional_context
attributes:
label: Additional context
description: >
Add any other relevant context, code examples, or screenshots that should be considered.
validations:
required: false
30 changes: 30 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Description
<!-- Provide a concise and descriptive summary of the changes implemented in this PR. -->

### Type of change
- [ ] 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)
- [ ] Documentation update (improves or adds clarity to existing documentation)

### Tested on
- [ ] iOS
- [ ] Android

### Testing instructions
<!-- Provide step-by-step instructions on how to test your changes. Include setup details if necessary. -->

### Screenshots
<!-- Add screenshots here, if applicable -->

### Related issues
<!-- Link related issues here using #issue-number -->

### Checklist
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have updated the documentation accordingly
- [ ] My changes generate no new warnings

### Additional notes
<!-- Include any additional information, assumptions, or context that reviewers might need to understand this PR. -->
Loading