Skip to content

Commit f82c72f

Browse files
Update bug_report.md
1 parent f002e3d commit f82c72f

File tree

1 file changed

+36
-20
lines changed

1 file changed

+36
-20
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+36-20
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,54 @@
11
---
22
name: Bug Report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: 'Status: Needs Review, Type: Bug'
6-
assignees: ''
7-
3+
about: Create a report to help us improve something that is not working correctly
4+
title: "Bug - :"
5+
labels: "Status: Needs Review, Type: Bug"
6+
assignees: ""
87
---
8+
99
<!-- Thank you for taking the time to submit a bug report to The Odin Project. In order to get issues closed in a reasonable amount of time, you must include a baseline of information about the bug in question. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
1010

11-
<!-- Complete the following REQUIRED checkboxes by replacing the whitespace between the square brackets with an 'x', e.g. [x]. -->
12-
- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md)
13-
- [ ] The title of this issue follows the `where the change occurs: brief description of bug` format, e.g. `React section: Knowledge Checks don't link to resource`
11+
Complete the following REQUIRED checkboxes:
12+
- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md)
13+
- [ ] The title of this issue follows the `Bug - location of bug: brief description of bug` format, e.g. `Bug - Exercises: File type incorrect for all test files`
14+
15+
The following checkbox is OPTIONAL:
16+
<!-- Completing this checkbox does not guarantee you will be assigned this issue, but rather lets us know you are interested in working on it. -->
17+
- [ ] I would like to be assigned this issue to work on it
1418

15-
<!-- The following checkbox is OPTIONAL. Completing it does not guarantee you will be assigned this issue, but rather lets us know you are interested in working on it. -->
16-
- [ ] I would like to be assigned this issue to work on it
19+
<hr>
1720

18-
**1. Description of the Bug**
21+
**1. Description of the Bug:**
1922
<!-- A clear and concise description of what the bug is. Include any screenshots that may help show the bug in action. -->
2023

2124

22-
**2. How To Reproduce**
23-
<!-- What steps one might need to take in order to reproduce this bug. -->
25+
**2. How To Reproduce:**
26+
<!--
27+
What steps one might need to take in order to reproduce this bug, e.g.:
28+
1. Log in
29+
2. Visit a lesson page
30+
3. Click the complete button
31+
4. The complete button does not update
32+
-->
2433

2534

26-
**3. Expected Behavior**
27-
<!-- A brief description of what you expected to happen. -->
35+
**3. Expected Behavior:**
36+
<!--
37+
A brief description of what you expected to happen, e.g.:
38+
1. Log in
39+
2. Visit a lesson page
40+
3. Click the complete button
41+
4. The complete button updates correctly
42+
-->
2843

2944

3045
**4. Desktop/Device:**
31-
- Device: <!-- [e.g. iPhone6] -->
32-
- OS: <!-- [e.g. iOS] -->
33-
- Browser: <!-- [e.g. chrome, safari] -->
34-
- Version: <!-- [e.g. 22] -->
46+
<!-- The more information you are able to provide, the better. -->
47+
- Device: <!-- [e.g. iPhone6] -->
48+
- OS: <!-- [e.g. iOS] -->
49+
- Browser: <!-- [e.g. chrome, safari] -->
50+
- Version: <!-- [e.g. 22] -->
3551

36-
**5. Additional Information**
52+
**5. Additional Information:**
3753
<!-- Any additional information about the bug. -->
3854

0 commit comments

Comments
 (0)