Issue and PR templates

This commit is contained in:
Angelos Chalaris
2018-02-27 18:01:03 +02:00
parent 06e7239de4
commit caa4ad241b
2 changed files with 53 additions and 0 deletions

25
.github/ISSUE_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,25 @@
<!--- Provide a general summary of the issue in the Title above -->
<!--- Add the prefix [BUG] or [FEATURE] to the Title -->
<!--- In case it's a feature suggestion, otherwise delete this section -->
<!--- Make sure there isn't already a snippet accomplishing your goal -->
## [FEATURE] _REPLACE THIS WITH A BRIEF SUMMARY OF THE SUGGESTED SNIPPET_
**Category:** <!-- One of the existing categories preferably -->
### Description <!-- IF NEEDED -->
<!-- More detailed description of the snippet you want to be included in 30-seconds-of-code -->
<!--- In case it's a bug, otherwise delete this section-->
<!--- Make sure there isn't already an open issue for your problem -->
## [BUG] _REPLACE THIS WITH A BRIEF SUMMARY OF YOUR ISSUE_
### Expected Snippet Behavior
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->
### Current Snippet Behavior
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
### Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->

28
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@ -0,0 +1,28 @@
<!--- Provide a general summary of your changes in the Title above -->
<!--- Add the prefix [FIX: #(issue number)], [FEATURE] or [ENHANCEMENT] to the Title -->
## Description
<!--- Describe your changes in detail -->
**Resolves** #(issue number) <!--- Delete if not a issue fix-->
## What does your PR belong to?
- [ ] Website
- [ ] Snippets
- [ ] General / Things regarding the repository (like CI Integration)
- [ ] Tests
## Types of changes
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] Enhancement (non-breaking improvement of a snippet)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
## Checklist:
<!--- 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.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have checked that the changes are working properly
- [ ] I have checked that there isn't any PR doing the same
- [ ] I have read the **CONTRIBUTING** document.