From c70d4a4cf6246bbbab21b87924870618766e7e65 Mon Sep 17 00:00:00 2001
From: Matthew Holt <mholt@users.noreply.github.com>
Date: Fri, 15 Feb 2019 10:35:51 -0700
Subject: [PATCH] Update pull request and issue templates

---
 .github/ISSUE_TEMPLATE.md                     | 32 -------
 .github/ISSUE_TEMPLATE/bug_report.md          | 83 +++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md     | 35 ++++++++
 .github/PULL_REQUEST_TEMPLATE.md              | 19 -----
 .github/PULL_REQUEST_TEMPLATE/pull_request.md | 40 +++++++++
 5 files changed, 158 insertions(+), 51 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index a7963b20c..000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,32 +0,0 @@
-<!--
-Are you asking for help with using Caddy? Please use our forum instead: https://caddy.community. If you are filing a bug report, please take a few minutes to carefully answer the following questions. If your issue is not a bug report, you do not need to use this template. Thanks!)
--->
-
-### 1. What version of Caddy are you using (`caddy -version`)?
-
-
-### 2. What are you trying to do?
-
-
-### 3. What is your entire Caddyfile?
-```text
-(paste Caddyfile here)
-```
-
-### 4. How did you run Caddy (give the full command and describe the execution environment)?
-
-
-### 5. Please paste any relevant HTTP request(s) here.
-
-<!-- Paste curl command, or full HTTP request including headers and body, here. -->
-
-
-### 6. What did you expect to see?
-
-
-### 7. What did you see instead (give full error messages and/or log)?
-
-
-### 8. How can someone who is starting from scratch reproduce the bug as minimally as possible?
-
-<!-- Please strip away any extra infrastructure such as containers, reverse proxies, upstream apps, caches, dependencies, etc, to prove this is a bug in Caddy and not an external misconfiguration. Your chances of getting this bug fixed go way up the easier it is to replicate. Thank you! -->
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..4815805d8
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,83 @@
+---
+name: Bug report
+about: For behaviors which violate documentation or cause incorrect results
+title: ''
+labels: ''
+assignees: ''
+---
+
+<!--
+This template is for bug reports. The lack of a feature is not a bug; to request a feature, please switch templates.
+
+Are you asking for help with using Caddy? Please ask on our forum: https://caddy.community
+
+Please do not skip relevant questions; this will slow down the debugging process and your issue may be closed.
+-->
+
+## 1. Which version of Caddy are you using (`caddy -version`)?
+<!-- If there is no version information, please paste commit SHA instead. -->
+
+
+
+
+## 2. What are you trying to do?
+<!-- Please clearly describe what you are trying to do thoroughly enough so that a reader with no background information can repeat it. -->
+
+
+
+
+## 3. What is your Caddyfile?
+```text
+paste entire Caddyfile here - DO NOT REDACT ANYTHING (except credentials)
+```
+<!-- Changing or hiding parts of your Caddyfile only slows things down and may result in your report being closed.
+For more information, see https://caddy.community/t/how-to-get-help-with-caddy-more-effectively/5222 -->
+<!-- If you are unable to post this publicly, we offer private support: https://caddyserver.com/products/support -->
+
+
+
+
+## 4. How did you run Caddy (give the full command and describe the execution environment)?
+<!-- IMPORTANT: Please eliminate Docker, systemd, reverse proxies, upstream dependencies, caches, firewalls, and other unnecessary, external factors from your setup first. This will help prove that this is a bug in Caddy and not a misconfiguration of your environment. We may close issues that are too complex to replicate. Thank you! -->
+
+
+
+
+## 5. Please paste any relevant HTTP request(s) here.
+<!-- Paste curl command, or full HTTP request including headers and body. You may skip this if the bug does not require HTTP requests. -->
+
+
+
+
+## 6. What did you expect to see?
+<!-- Describe your expected results as precisely as possible. -->
+
+
+
+
+## 7. What did you see instead (give full error messages and/or log)?
+<!-- Please run Caddy with the -log flag, and use the log and errors directives as needed. DO NOT REDACT INFORMATION except for credentials. See https://caddy.community/t/how-to-get-help-with-caddy-more-effectively/5222 -->
+
+
+
+
+## 8. Why is this a bug, and how do you think this should be fixed?
+<!-- Help us understand why it is a bug; it is not always obvious. You can help us get this resolved faster by thinking about the problem and describing possible solutions! -->
+
+
+
+
+## 9. What are you doing to work around the problem in the meantime?
+<!-- This can help others who encounter the same problem, until we implement a fix. -->
+
+
+
+
+## 10. Please link to any related issues, pull requests, and/or discussion.
+<!-- This can add crucial context to your report. -->
+
+
+
+
+## Bonus: What do you use Caddy for? Why did you choose Caddy?
+<!-- We'd like to know! -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 000000000..3f7578a99
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,35 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature request
+assignees: ''
+---
+
+<!--
+This template is for feature requests. If you are reporting a bug instead, please switch templates.
+
+Are you asking for help with using Caddy? Please ask on our forum: https://caddy.community
+-->
+
+
+## 1. What would you like to have changed?
+<!-- Fully describe the feature or enhancement you are requesting; examples can be helpful too -->
+
+
+
+
+## 2. Why is this feature a useful, necessary, and/or important addition to this project?
+<!-- Please justify why this change adds value to the project, considering the added maintenance burden and complexity the change introduces -->
+
+
+
+
+## 3. What alternatives are there, or what are you doing in the meantime to work around the lack of this feature?
+<!-- We want to get an idea of what is being done in practice, or how other projects support your feature -->
+
+
+
+
+## 4. Please link to any relevant issues, pull requests, or other discussions.
+<!-- This adds crucial context to your feature request and can speed things up -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
deleted file mode 100644
index 3d0eba238..000000000
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ /dev/null
@@ -1,19 +0,0 @@
-<!--
-Thank you for contributing to Caddy! Please fill this out to help us make the most of your pull request.
--->
-
-### 1. What does this change do, exactly?
-
-
-### 2. Please link to the relevant issues.
-
-
-### 3. Which documentation changes (if any) need to be made because of this PR?
-
-
-### 4. Checklist
-
-- [ ] I have written tests and verified that they fail without my change
-- [ ] I have squashed any insignificant commits
-- [ ] This change has comments for package types, values, functions, and non-obvious lines of code
-- [ ] I am willing to help maintain this change if there are issues with it later
diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request.md b/.github/PULL_REQUEST_TEMPLATE/pull_request.md
new file mode 100644
index 000000000..b6d81cd7b
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE/pull_request.md
@@ -0,0 +1,40 @@
+---
+name: Pull request
+about: Propose changes to the code
+title: ''
+labels: ''
+assignees: ''
+---
+
+<!--
+Thank you for contributing to Caddy! Please fill this out to help us make the most of your pull request.
+
+Was this change discussed in an issue first? That can help save time in case the change is not a good fit for the project. Not all pull requests get merged.
+
+It is not uncommon for pull requests to go through several, iterative reviews. Please be patient with us! Every reviewer is a volunteer, and each has their own style.
+-->
+
+## 1. What does this change do, exactly?
+<!-- Please be specific. Motivate the problem, and justify why this is the best solution. -->
+
+
+
+
+## 2. Please link to the relevant issues.
+<!-- This adds crucial context to your change. -->
+
+
+
+
+## 3. Which documentation changes (if any) need to be made because of this PR?
+<!-- Reviewers will often reference this first in order to know what to expect from the change. Please be specific enough so that they can paste your wording into the documentation directly. -->
+
+
+
+
+## 4. Checklist
+
+- [ ] I have written tests and verified that they fail without my change
+- [ ] I have squashed any insignificant commits
+- [ ] This change has comments explaining package types, values, functions, and non-obvious lines of code
+- [ ] I am willing to help maintain this change if there are issues with it later