Skip to content

Commit e480b4d

Browse files
GabefireAdrian Chang
authored andcommitted
added basic pr request template
1 parent 372fdcc commit e480b4d

File tree

3 files changed

+46
-38
lines changed

3 files changed

+46
-38
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,23 @@
1-
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
8-
---
9-
10-
**Describe the bug**
1+
# Describe the bug
112
A clear and concise description of what the bug is.
123

13-
**To Reproduce**
4+
# To reproduce
145
Steps to reproduce the behavior:
156
1. Go to '...'
167
2. Click on '....'
178
3. Scroll down to '....'
189
4. See error
1910

20-
**Expected behavior**
11+
# Expected behavior
2112
A clear and concise description of what you expected to happen.
2213

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
14+
# Screenshots / Videos
15+
If applicable, add screenshots or videos to help explain your problem.
2516

26-
**Desktop (please complete the following information):**
17+
# Environment (please complete the following information
2718
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
30-
31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
19+
- Python Version: [e.g. 3.8.12]
20+
- SDK + SDK Version: [e.g. labelbox@3.70.0 / labelbox[data]@3.71.0]
3621

37-
**Additional context**
22+
# Additional context
3823
Add any other context about the problem here.
Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,11 @@
1-
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
8-
---
9-
10-
**Is your feature request related to a problem? Please describe.**
1+
# Is your feature request related to a problem? Please describe.
112
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
123

13-
**Describe the solution you'd like**
4+
# Describe the solution you'd like
145
A clear and concise description of what you want to happen.
156

16-
**Describe alternatives you've considered**
7+
# Describe alternatives you've considered
178
A clear and concise description of any alternative solutions or features you've considered.
189

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
10+
# Additional context
11+
Add any other context or screenshots about the feature request here.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Description
2+
3+
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Document change (fix typo or modifying any markdown files, code comments or anything in the examples folder only)
15+
16+
## All Submissions
17+
18+
- [ ] Have you followed the guidelines in our Contributing document?
19+
- [ ] Have you provided a description?
20+
- [ ] Are your changes properly formatted?
21+
22+
## New Feature Submissions
23+
24+
- [ ] Does your submission pass tests?
25+
- [ ] Have you added thorough tests for your new feature?
26+
- [ ] Have you commented your code, particularly in hard-to-understand areas?
27+
28+
## Changes to Core Features
29+
30+
- [ ] Have you written new tests for your core changes, as applicable?
31+
- [ ] Have you successfully run tests with your changes locally?
32+
- [ ] Have you updated any code comments, as applicable?

0 commit comments

Comments
 (0)