From 82f2c26b431c3022c00c912a8f2382c9e674b2f5 Mon Sep 17 00:00:00 2001 From: Naylin Medina Date: Thu, 31 May 2018 15:36:12 -0400 Subject: [PATCH] docs(github): add issues and pull request templates Signed-off-by: Naylin Medina --- .github/Feature_request.md | 17 ++++++++++++++ .github/ISSUE_TEMPLATE.md | 9 +++++++ .github/ISSUE_TEMPLATE/Bug_report.md | 35 ++++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++++ 4 files changed, 77 insertions(+) create mode 100644 .github/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/Feature_request.md b/.github/Feature_request.md new file mode 100644 index 0000000..5384295 --- /dev/null +++ b/.github/Feature_request.md @@ -0,0 +1,17 @@ +--- +name: Feature request +about: Suggest an idea for this project + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..6f2cba8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,9 @@ + + +### Observed Results + + + +### Expected behavior + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 0000000..4de26c7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..0272466 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +### Changes description + + + +### Checklist + +Please check if your PR fulfills the following specifications: + +- [ ] Tests for the changes have been added +- [ ] Docs have been added/updated + +### References + + + +Closes #N/A \ No newline at end of file