zaibutcooler commited on
Commit
58d69fc
1 Parent(s): 10e0c39

issue template and pr template

Browse files
.github/ISSUE_TEMPLATE/bug_report.md ADDED
@@ -0,0 +1,38 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
11
+ A clear and concise description of what the bug is.
12
+
13
+ ## To Reproduce
14
+ Steps to reproduce the behavior:
15
+ 1. Go to '...'
16
+ 2. Click on '....'
17
+ 3. Scroll down to '....'
18
+ 4. See error
19
+
20
+ ## Expected behavior
21
+ A clear and concise description of what you expected to happen.
22
+
23
+ ## Screenshots
24
+ If applicable, add screenshots to help explain your problem.
25
+
26
+ ## Desktop (please complete the following information):
27
+ - 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]
36
+
37
+ ## Additional context
38
+ Add any other context about the problem here.
.github/ISSUE_TEMPLATE/feature_request.md ADDED
@@ -0,0 +1,20 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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.**
11
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
+
13
+ **Describe the solution you'd like**
14
+ A clear and concise description of what you want to happen.
15
+
16
+ **Describe alternatives you've considered**
17
+ A clear and concise description of any alternative solutions or features you've considered.
18
+
19
+ **Additional context**
20
+ Add any other context or screenshots about the feature request here.
.github/PULL_REQUEST_TEMPLATE.md ADDED
@@ -0,0 +1,34 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ## What
2
+
3
+ <!-- Briefly describe the changes introduced by this pull request -->
4
+
5
+ ## Why
6
+
7
+ <!-- Why were these changes neccesary? -->
8
+
9
+ ## How
10
+
11
+ <!-- Describe in detail the changes and improvements made by this PR -->
12
+
13
+
14
+ ## Related Issues
15
+
16
+ <!-- Mention any related issues or links to discussions -->
17
+
18
+ ## Screenshots / GIFs (if applicable)
19
+
20
+ <!-- If applicable, add screenshots or GIFs showcasing the changes -->
21
+
22
+ ## Checklist
23
+
24
+ - [ ] I have tested these changes locally
25
+ - [ ] I have ensured my code follows the project's coding style
26
+ - [ ] I have updated the documentation accordingly
27
+ - [ ] My changes do not introduce any new warnings or errors
28
+ - [ ] All tests pass successfully
29
+ - [ ] I have added/updated unit tests (if necessary)
30
+
31
+ ## Additional Notes
32
+
33
+ <!-- Any additional information or notes for the reviewers -->
34
+