Skip to content

Commit f8ff4b0

Browse files
committed
add Github Template Files that will enable Contributors Communicate Intentions better
1 parent f7af60d commit f8ff4b0

File tree

3 files changed

+76
-0
lines changed

3 files changed

+76
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: "\U0001F41BBug report"
3+
about: Report an Issue
4+
---
5+
6+
<!--- Provide a general summary of the issue in the Title above -->
7+
8+
## Expected Behavior
9+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
10+
11+
## Current Behavior
12+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
13+
14+
## Possible Solution
15+
<!--- Not obligatory, but suggest a fix/reason -->
16+
<!--- or ideas how to implement the addition or change -->
17+
18+
## Steps to Reproduce
19+
<!--- Provide a link to a live example -->
20+
21+
## Context [OPTIONAL]
22+
<!--- How has this issue affected you? What are you trying to accomplish? -->
23+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: "\U0001F680Feature or Enhancement"
3+
about: Suggest an Idea or Enhancement
4+
---
5+
6+
### Description
7+
8+
<!--- Provide a detailed description of the change or addition you are proposing -->
9+
10+
### Why
11+
12+
<!--- Why is this change important to you? How would you use it? -->
13+
14+
<!--- How can it benefit other users? -->
15+
16+
### Possible Implementation & Open Questions
17+
18+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
19+
20+
<!--- What still needs to be discussed -->
21+
22+
### Is this something you're interested in working on?
23+
24+
<!--- Yes or no -->
25+
- [ ] YES
26+
- [ ] NO

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
<!--- Describe your changes in detail -->
5+
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. -->
9+
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. -->
14+
15+
## Types of changes
16+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
17+
- [ ] Content Update (change which fixes an issue or updates an already existing submission)
18+
- [ ] New Article (change which adds functionality)
19+
- [ ] Documentation change
20+
21+
## Checklist:
22+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
23+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
24+
- [ ] My code follows the code style of this project.
25+
- [ ] I have updated the documentation accordingly.
26+
- [ ] I have read the **CONTRIBUTING** document.
27+
- [ ] I have made checks to ensure URLs and other resources are valid

0 commit comments

Comments
 (0)