From 5a0a80832a2cd5b8b10c5ccd2c800deb40e63e4f Mon Sep 17 00:00:00 2001
From: ssube <seansube@gmail.com>
Date: Wed, 18 Sep 2019 09:21:27 -0500
Subject: [PATCH] feat(github): add issue and PR templates

---
 .github/ISSUE_TEMPLATE/type_bug.md     | 36 ++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/type_feature.md | 29 +++++++++++++++++++++
 .github/ISSUE_TEMPLATE/type_update.md  | 30 +++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md       | 23 ++++++++++++++++
 4 files changed, 118 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/type_bug.md
 create mode 100644 .github/ISSUE_TEMPLATE/type_feature.md
 create mode 100644 .github/ISSUE_TEMPLATE/type_update.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE/type_bug.md b/.github/ISSUE_TEMPLATE/type_bug.md
new file mode 100644
index 0000000..5904c9d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/type_bug.md
@@ -0,0 +1,36 @@
+---
+name: Bug Report
+about: report a problem
+title: ''
+labels: status/new, type/bug
+assignees: ''
+
+---
+
+### Summary
+
+(quick summary of the issue)
+
+### Steps to Reproduce
+
+- install
+- configure
+- run
+- ...
+- :(
+
+### Actual Behavior
+
+```none
+example
+```
+
+### Expected Behavior
+
+```none
+example
+```
+
+### Details
+
+(detailed description of the expected behavior and what goes wrong)
diff --git a/.github/ISSUE_TEMPLATE/type_feature.md b/.github/ISSUE_TEMPLATE/type_feature.md
new file mode 100644
index 0000000..9b9cd7b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/type_feature.md
@@ -0,0 +1,29 @@
+---
+name: Feature Suggestion
+about: Suggest an idea for this project
+title: ''
+labels: status/new, type/feature
+assignees: ''
+
+---
+
+### Summary
+
+An elevator pitch of the feature and why it will be useful.
+
+### Scope
+
+- [ ] items to be implemented
+  - [ ] additional details
+
+### Use Case
+
+At least one concrete use case for the feature, ideally with step-by-step example.
+
+Bonus points if you can refer to another issue here.
+
+### Questions
+
+Outstanding questions, potential problems, and further research that might be needed.
+
+New or updated dependencies should be noted here.
diff --git a/.github/ISSUE_TEMPLATE/type_update.md b/.github/ISSUE_TEMPLATE/type_update.md
new file mode 100644
index 0000000..40c2f4f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/type_update.md
@@ -0,0 +1,30 @@
+---
+name: Dependency Update
+about: update a dependency
+title: ''
+labels: status/new, type/update
+assignees: ''
+
+---
+
+### Summary
+
+(what needs to be updated)
+
+### Version
+
+- current version
+- target version
+- latest version (if target < latest)
+
+### Use Case
+
+(at least one solid use case for the update)
+
+### Issues
+
+(potential problems, questions, research)
+
+### Details
+
+(other changes that need to happen first)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..91f14cb
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,23 @@
+### Issue
+
+List the issue(s) resolved or addressed by this change.
+
+Changes MUST be related to an issue. If one does not exist, please create one with
+[the appropriate issue type](https://github.com/ssube/isolex/blob/master/docs/workflow.md#type).
+
+### Check
+
+Before creating a PR, please ensure
+[all merge requirements](https://github.com/ssube/isolex/blob/master/docs/workflow.md#merges) are met:
+
+- [ ] Gitlab pipeline has passed
+- [ ] lint warnings have not increased
+- [ ] documentation has been updated
+- [ ] tests have been added and consistently pass
+
+### Todo
+
+If this PR is still a work in progress, please prefix the title with `WIP:` and include the remaining tasks:
+
+- [ ] next thing
+- [ ] last thing