From 9c4bd386240fd17c32a0ebb5d4c181fd03cfcf59 Mon Sep 17 00:00:00 2001
From: Bobby DeSimone <bobbydesimone@gmail.com>
Date: Wed, 2 Oct 2019 15:25:07 -0700
Subject: [PATCH] github: make issue templates less annoying

Signed-off-by: Bobby DeSimone <bobbydesimone@gmail.com>
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 26 +++++++++-----------
 .github/ISSUE_TEMPLATE/feature_request.md |  4 ----
 .github/PULL_REQUEST_TEMPLATE             | 29 ++++++++++-------------
 3 files changed, 24 insertions(+), 35 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index fad18dce5..130e75ac0 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -3,39 +3,35 @@ name: Bug report
 about: Let us know about a bug!
 ---
 
-<!-- Please reserve GitHub issues for bug reports and feature requests. -->
+## What happened?
 
- **Describe the bug** A clear and concise description of what the bug is.
+## What did you expect to happen?
 
-**To Reproduce** Steps to reproduce the behavior:
+## How'd it happen?
 
 1. Ran `x`
 2. Clicked `y`
 3. Saw error `z`
 
-**Expected behavior**
+## What's your environment like?
 
-A clear and concise description of what you expected to happen.
-
-**Environment:**
-
-- Pomerium version (retrieve with `pomerium --version`):
+- Pomerium version (retrieve with `pomerium --version` or `/ping` endpoint):
 - Server Operating System/Architecture/Cloud:
 
-Configuration file(s):
+## What's your config.yaml?
 
-```text
+```config.yaml
 # Paste your configs here
 # Be sure to scrub any sensitive values
 ```
 
-Logs(s):
+## What did you see in the logs?
 
-```text
-# Paste your configs here.
+```logs
+# Paste your logs here.
 # Be sure to scrub any sensitive values
 ```
 
-**Additional context**
+## Additional context
 
 Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index fe17cb5d8..62f428346 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -9,12 +9,8 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
 
 **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.
-
 **Explain any additional use-cases**
 
 If there are any use-cases that would help us understand the use/need/value please share them as they can help us decide on acceptance and prioritization.
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
index 17d2b51e5..2c154b82d 100644
--- a/.github/PULL_REQUEST_TEMPLATE
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -1,25 +1,22 @@
-<!--  
-Thanks for sending a pull request!
-We generally follow Go coding and contributing conventions
-https://golang.org/doc/contribute.html#commit_messages
+## Summary
+<!--  For example...
+The existing implementation has poor numerical properties for
+large arguments, so use the McGillicutty algorithm to improve
+accuracy above 1e10.
 
-Here's an example of a good PR/Commit:
+The algorithm is described at https://wikipedia.org/wiki/McGillicutty_Algorithm
+-->
 
-    math: improve Sin, Cos and Tan precision for very large arguments
-
-    The existing implementation has poor numerical properties for
-    large arguments, so use the McGillicutty algorithm to improve
-    accuracy above 1e10.
-
-    The algorithm is described at https://wikipedia.org/wiki/McGillicutty_Algorithm
-
-    Fixes #159
+## Related issues
+<!-- For example...
+Fixes #159 
 -->
 
 
 **Checklist**:
+- [ ] add related issues
 - [ ] updated docs
-- [ ] unit tests added
-- [ ] related issues referenced
+- [ ] updated unit tests
 - [ ] updated CHANGELOG.md
+- [ ] updated UPGRADING.md
 - [ ] ready for review