Skip to content

Commit e0516cc

Browse files
committed
docs: Update PR and issue templates
Signed-off-by: Ivan Kanakarakis <[email protected]>
1 parent e8bba94 commit e0516cc

File tree

2 files changed

+29
-18
lines changed

2 files changed

+29
-18
lines changed

.github/issue_template.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1-
<!--- Provide a general summary of the issue in the Title above -->
1+
<!-- Provide a general summary of the issue in the Title above -->
22

3-
## Code Version
3+
### Code Version
44
<!-- What version and/or branch of the code are you running? -->
55

6-
## Expected Behavior
7-
<!--- Tell us what should happen -->
6+
### Expected Behavior
7+
<!-- Tell us what should happen -->
88

9-
## Current Behavior
10-
<!--- Tell us what happens instead of the expected behavior -->
9+
### Current Behavior
10+
<!-- Tell us what happens instead of the expected behavior -->
1111

12-
## Possible Solution
13-
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
12+
### Possible Solution
13+
<!-- Not obligatory, but suggest a fix/reason for the bug, -->
14+
15+
### Steps to Reproduce
16+
<!-- Provide a link to a live example -->
17+
<!-- or, an unambiguous set of steps to reproduce this bug -->
18+
<!-- Include code to reproduce, if relevant -->
1419

15-
## Steps to Reproduce
16-
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
17-
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1820
1.
1921
2.
2022
3.

.github/pull_request_template.md

+16-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,20 @@
1-
### All Submissions:
1+
### Description
22

3-
* [ ] Have you checked to ensure there aren't other open [Pull Requests](../../pulls) for the same update/change?
4-
* [ ] Have you added an explanation of what problem you are trying to solve with this PR?
5-
* [ ] Have you added information on what your changes do and why you chose this as your solution?
6-
* [ ] Have you written new tests for your changes?
7-
* [ ] Does your submission pass tests?
8-
* [ ] This project follows PEP8 style guide. Have you run your code against the 'flake8' linter?
3+
##### The feature or problem addressed by this PR
94

5+
<!-- an explaination of the issue that is being resolved with this PR -->
6+
<!-- or, an explaination of the feature that is being added with this PR -->
7+
<!-- or, link to an issue describing the problem -->
108

119

10+
##### What your changes do and why you chose this solution
11+
12+
<!-- description of the technical changes that help resolve the issue -->
13+
14+
15+
### Checklist
16+
17+
* [ ] Checked that no other issues or pull requests exist for the same issue/change
18+
* [ ] Added tests covering the new functionality
19+
* [ ] Updated documentation OR the change is too minor to be documented
20+
* [ ] Updated CHANGELOG.md OR changes are insignificant

0 commit comments

Comments
 (0)