Skip to content

Commit 2586a84

Browse files
thatblindgeyethatblindgeye
authored
Merge pull request TheOdinProject#231 from TheOdinProject/thatblindgeye-patch-2
Templates: Create PR and Issue files
2 parents 1971712 + 649f0e3 commit 2586a84

File tree

3 files changed

+122
-0
lines changed

3 files changed

+122
-0
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/bug_report.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: Bug Report
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: ""
7+
---
8+
9+
<!-- 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. -->
10+
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
18+
19+
<hr>
20+
21+
**1. Description of the Bug:**
22+
<!-- A clear and concise description of what the bug is. Include any screenshots that may help show the bug in action. -->
23+
24+
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+
-->
33+
34+
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+
-->
43+
44+
45+
**4. Desktop/Device:**
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] -->
51+
52+
**5. Additional Information:**
53+
<!-- Any additional information about the bug. -->
54+

Diff for: ‎.github/ISSUE_TEMPLATE/feature_request.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement for this project
4+
title: ""
5+
labels: "Status: Needs Review"
6+
assignees: ""
7+
---
8+
9+
<!-- Thank you for taking the time to submit a new feature request 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 feature/enhancement you are proposing. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
10+
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 `location for request: brief description of request` format, e.g. `Exercises: Add exercise on XYZ`
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
18+
19+
<hr>
20+
21+
**1. Description of the Feature Request:**
22+
<!--
23+
A clear and concise description of what the feature or enhancement is, including how it would be useful/beneficial or what problem(s) it would solve.
24+
-->
25+
26+
27+
**2. Acceptance Criteria:**
28+
<!--
29+
A list of checkbox items that explain the requirements needed to be met to resolve this request, e.g.:
30+
- [ ] A theme toggle is present on the dashboard
31+
- [ ] Clicking the theme toggle changes between light and dark
32+
- [ ] A user's theme choice persists after leaving the website
33+
-->
34+
35+
36+
**3. Additional Information:**
37+
<!-- Any additional information about the feature request, such as a link to a Discord discussion, screenshots, etc. -->
38+

Diff for: ‎.github/PULL_REQUEST_TEMPLATE.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<!-- Thank you for taking the time to contribute to The Odin Project. In order to get a pull request (PR) closed in a reasonable amount of time, you must include a baseline of information about the changes you are proposing. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
2+
3+
Complete the following REQUIRED checkboxes:
4+
<!-- While editing this template, replace the whitespace between the square brackets with an 'x', e.g. [x] -->
5+
- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md)
6+
- [ ] The title of this PR follows the `location of change: brief description of change` format, e.g. `01_helloWorld: Update test cases`
7+
8+
Complete the following checkboxes ONLY IF they are applicable to your PR. You can complete them later if they are not currently applicable:
9+
- [ ] I have ensured any exercise files included in this PR have passed all of their tests
10+
11+
<hr>
12+
13+
**1. Because:**
14+
<!--
15+
If this PR closes an open issue, replace the XXXXX below with the issue number, e.g. Closes #2013. Or if the issue is in another TOP repo replace the #XXXXX with the URL of the issue, e.g. Closes https://github.com/TheOdinProject/curriculum/issues/XXXXX
16+
17+
Otherwise, provide a clear and concise reason for your pull request, e.g. what problem it solves or what benefit it provides. If this PR is related to, but does not close, another issue or PR, you can also link it as above without the 'Closes' keyword, e.g. "Related to #2013".
18+
-->
19+
Closes #XXXXX
20+
21+
22+
**2. This PR:**
23+
<!--
24+
A bullet point list of one or more items outlining what was done in this PR to solve the problem(s) or implement the feature/enhancement.
25+
-->
26+
27+
28+
**3. Additional Information:**
29+
<!-- Any additional information about the PR, such as a link to a Discord discussion, etc. -->
30+

0 commit comments

Comments
 (0)