Skip to content

Commit f9b71a2

Browse files
committed
Add github templates
1 parent a2cd413 commit f9b71a2

File tree

2 files changed

+87
-0
lines changed

2 files changed

+87
-0
lines changed

.github/ISSUE_TEMPLATE.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<!-- These sections are meant as guidance for you, to help you give the kind of information we'll need to help with your issue. If a section doesn't seem to fit, just skip it.
2+
3+
In general: Please provide as much information as you can to help us solving your problem -->
4+
5+
## Summary
6+
7+
<!--- Provide a general summary description of the issue -->
8+
9+
## Expected Behavior
10+
11+
<!--- If you're describing a bug, tell us what should happen -->
12+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
13+
<!--- Feel free to use Given / Then / Then if that helps, but please add some plain-language context too -->
14+
15+
## Current Behavior
16+
17+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
18+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
19+
20+
<!--- If you have got some output place it in the code block below. Otherwise remove it. -->
21+
~~~
22+
~~~
23+
24+
## Possible Solution
25+
26+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
27+
<!--- or ideas how to implement the addition or change -->
28+
29+
## Steps to Reproduce (for bugs)
30+
31+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
32+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
33+
1.
34+
2.
35+
3.
36+
4.
37+
38+
## Context & Motivation
39+
40+
<!--- How has this issue affected you? What are you trying to accomplish? -->
41+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
42+
43+
## Your Environment
44+
45+
<!--- If you're reporting a bug, include as many relevant details about the environment you experienced the bug in -->
46+
* Version used:
47+
* Operating System and version:
48+
* Link to your project:

.github/PULL_REQUEST_TEMPLATE.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!-- These sections are meant as guidance for you. If something doesn't fit, you can just skip it. -->
2+
3+
## Summary
4+
5+
<!--- Provide a general summary description of your changes -->
6+
7+
## Details
8+
9+
<!--- Describe your changes in detail -->
10+
11+
## Motivation and Context
12+
13+
<!--- Why is this change required? What problem does it solve? -->
14+
<!--- If it fixes an open issue, please link to the issue here. -->
15+
16+
## How Has This Been Tested?
17+
18+
<!--- Please add tests for changes to the code, otherwise we probably won't merge it -->
19+
20+
<!--- Please describe in detail how you tested your changes. -->
21+
<!--- Include details of your testing environment, tests ran to see how -->
22+
<!--- your change affects other areas of the code, etc. -->
23+
24+
## Screenshots (if appropriate):
25+
26+
## Types of changes
27+
28+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
29+
- [ ] Bug fix (non-breaking change which fixes an issue).
30+
- [ ] New feature (non-breaking change which adds functionality).
31+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
32+
33+
## Checklist:
34+
35+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
36+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
37+
- [ ] I've added tests for my code.
38+
- [ ] My change requires a change to the documentation.
39+
- [ ] I have updated the documentation accordingly.

0 commit comments

Comments
 (0)