mirror of
https://github.com/practical-tutorials/project-based-learning.git
synced 2024-11-27 14:01:14 +00:00
add Github Template Files that will enable Contributors Communicate Intentions better
This commit is contained in:
parent
f7af60d24c
commit
f8ff4b0418
23
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
Normal file
23
.github/ISSUE_TEMPLATE/Bug_report.md
vendored
Normal file
|
@ -0,0 +1,23 @@
|
|||
---
|
||||
name: "\U0001F41BBug report"
|
||||
about: Report an Issue
|
||||
---
|
||||
|
||||
<!--- Provide a general summary of the issue in the Title above -->
|
||||
|
||||
## Expected Behavior
|
||||
<!--- If you're suggesting a change/improvement, tell us how it should work -->
|
||||
|
||||
## Current Behavior
|
||||
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
|
||||
|
||||
## Possible Solution
|
||||
<!--- Not obligatory, but suggest a fix/reason -->
|
||||
<!--- or ideas how to implement the addition or change -->
|
||||
|
||||
## Steps to Reproduce
|
||||
<!--- Provide a link to a live example -->
|
||||
|
||||
## Context [OPTIONAL]
|
||||
<!--- How has this issue affected you? What are you trying to accomplish? -->
|
||||
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
|
26
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
Normal file
26
.github/ISSUE_TEMPLATE/Feature_request.md
vendored
Normal file
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
name: "\U0001F680Feature or Enhancement"
|
||||
about: Suggest an Idea or Enhancement
|
||||
---
|
||||
|
||||
### Description
|
||||
|
||||
<!--- Provide a detailed description of the change or addition you are proposing -->
|
||||
|
||||
### Why
|
||||
|
||||
<!--- Why is this change important to you? How would you use it? -->
|
||||
|
||||
<!--- How can it benefit other users? -->
|
||||
|
||||
### Possible Implementation & Open Questions
|
||||
|
||||
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
|
||||
|
||||
<!--- What still needs to be discussed -->
|
||||
|
||||
### Is this something you're interested in working on?
|
||||
|
||||
<!--- Yes or no -->
|
||||
- [ ] YES
|
||||
- [ ] NO
|
27
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
27
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
|
@ -0,0 +1,27 @@
|
|||
<!--- Provide a general summary of your changes in the Title above -->
|
||||
|
||||
## Description
|
||||
<!--- Describe your changes in detail -->
|
||||
|
||||
## Motivation and Context
|
||||
<!--- Why is this change required? What problem does it solve? -->
|
||||
<!--- If it fixes an open issue, please link to the issue here. -->
|
||||
|
||||
## How Has This Been Tested?
|
||||
<!--- Please describe in detail how you tested your changes. -->
|
||||
<!--- Include details of your testing environment, and the tests you ran to -->
|
||||
<!--- see how your change affects other areas of the code, etc. -->
|
||||
|
||||
## Types of changes
|
||||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
||||
- [ ] Content Update (change which fixes an issue or updates an already existing submission)
|
||||
- [ ] New Article (change which adds functionality)
|
||||
- [ ] Documentation change
|
||||
|
||||
## Checklist:
|
||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
||||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
||||
- [ ] My code follows the code style of this project.
|
||||
- [ ] I have updated the documentation accordingly.
|
||||
- [ ] I have read the **CONTRIBUTING** document.
|
||||
- [ ] I have made checks to ensure URLs and other resources are valid
|
Loading…
Reference in New Issue
Block a user