Skip to content

Commit

Permalink
added first version of PR templates and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jdknives committed May 23, 2019
1 parent 64c581b commit ea81b62
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: 'bug'
assignees: ''

---

**Describe the bug**
A clear and concise description of the problem and bug effects.

**Environment information:**

- OS: e.g. Linux, Windows, Mac OS X
- Platform: the equivalent of `uname -smr` or `uname -smrv` e.g. Darwin 17.4.0 x86_64

**Steps to Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Run '....'
3. Write data to '....'
4. See error

**Actual behavior**
Explain the failure modes and effects, everything indicating the existence of the bug.
If applicable, add logs or screenshots of the bug.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Additional context**
Add any other context about the problem here.

**Possible implementation**
Hints to fix the bug.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'feature'
assignees: ''

---

**Feature description**

Describe the feature

**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 about the problem here.

**Possible implementation**
Preliminary ideas to get this done.
If you have all details in mind then provide a checklist

- [ ] Start with ...
- [ ] When done do ...
- [ ] Finally ...
6 changes: 6 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Fixes #

Changes:
-

How to test this PR:

0 comments on commit ea81b62

Please sign in to comment.