Skip to content

Commit a4b8643

Browse files
committed
Another attempt at keeping stuff organized
1 parent 0f496b1 commit a4b8643

2 files changed

Lines changed: 46 additions & 23 deletions

File tree

.github/ISSUE_TEMPLATE.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,31 @@
1-
GitHub issues are for bug reporting and feature requests.
1+
<!--- Provide a general summary of the issue in the Title above -->
22

3-
Please provide the following information.
4-
The more information you provide, the more easily we will be able to offer
5-
help and advice.
3+
## Expected Behavior
4+
<!--- If you're describing a bug, tell us what should happen -->
5+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
66

7-
### Environment info
8-
Operating system:
7+
## Current Behavior
8+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
9+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
910

10-
Installed version of Python (from `python -V`):
11+
## Possible Solution
12+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
13+
<!--- or ideas how to implement the addition or change -->
1114

12-
Affected commit:
13-
14-
### Steps to reproduce
15+
## Steps to Reproduce (for bugs)
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 -->
1518
1.
1619
2.
1720
3.
21+
4.
1822

19-
### What have you tried?
20-
1.
23+
## Context
24+
<!--- How has this issue affected you? What are you trying to accomplish? -->
25+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
2126

22-
### Logs or other output that would be helpful
23-
(If logs are large, please upload as attachment).
27+
## Your Environment
28+
<!--- Include as many relevant details about the environment you experienced the bug in -->
29+
* Version used:
30+
* Environment name and version (e.g. Python 2.7):
31+
* Operating System and version (desktop or mobile):

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
1-
This pull request includes a
1+
<!--- Provide a general summary of your changes in the Title above -->
22

3-
- [ ] Bug fix
4-
- [ ] New feature
5-
- [ ] Translation
3+
## Description
4+
<!--- Describe your changes in detail -->
65

7-
The following changes were made
6+
## Motivation and Context
7+
<!--- Why is this change required? What problem does it solve? -->
8+
<!--- If it fixes an open issue, please link to the issue here. -->
89

9-
-
10-
-
11-
-
10+
## How Has This Been Tested?
11+
<!--- Please describe in detail how you tested your changes. -->
12+
<!--- Include details of your testing environment, and the tests you ran to -->
13+
<!--- see how your change affects other areas of the code, etc. -->
1214

13-
If this is related to an existing ticket, include a link to it as well.
15+
## Screenshots (if appropriate):
16+
17+
## Types of changes
18+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
19+
- [ ] Bug fix (non-breaking change which fixes an issue)
20+
- [ ] New feature (non-breaking change which adds functionality)
21+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
22+
23+
## Checklist:
24+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
25+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
26+
- [ ] My code follows the code style of this project.
27+
- [ ] My change requires a change to the documentation.
28+
- [ ] I have updated the documentation accordingly.

0 commit comments

Comments
 (0)