From 2af684986eac56d7f82fb9f9ef6481c6a96be933 Mon Sep 17 00:00:00 2001
From: Solly Ross <sollyross@google.com>
Date: Mon, 30 Sep 2019 16:25:00 -0700
Subject: [PATCH] Fixup PR/issue templates

The PR/issue templates that got merged didn't quite match what we
wanted, so this attempts to fix them up.
---
 .github/ISSUE_TEMPLATE/bug_report.md       | 44 +++++++++++-----------
 .github/ISSUE_TEMPLATE/feature_request.md  | 26 ++++++++++---
 .github/ISSUE_TEMPLATE/support-question.md | 33 +++++++++++++++-
 .github/PULL_REQUEST_TEMPLATE.md           | 23 ++++++-----
 4 files changed, 87 insertions(+), 39 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 000f48e096e..69fed3860f2 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,8 +1,7 @@
 ---
 name: Bug report
-about: Problems and issues
+about: Problems and issues with code or docs
 title: ''
-labels: kind/bug
 assignees: ''
 
 ---
@@ -15,32 +14,35 @@ assignees: ''
 
 -->
 
-/kind bug
-
 <!-- 
-Thanks for filing an issue! Before hitting the button, please answer these questions.
-Fill in as much of the template below as you can. If you leave out information, we can't help you as well.
+
+Hiya!  Welcome to KubeBuilder!  For a smooth issue process, try to answer the following questions.
+Don't worry if they're not all applicable; just try to include what you can :-)
+
+If you need to include code snippets or logs, please put them in fenced code
+blocks.  If they're super-long, please use the details tag like
+<details><summary>super-long log</summary> lots of stuff </details>
+
 -->
 
-**What did you do?**
-A clear and concise description of the steps you took (or insert a code snippet).
+<!-- What broke (please include exact error messages if you can) -->
+
+<!-- What did you expect to happen?  What do you think went wrong? -->
 
-**What did you expect to see?**
-A clear and concise description of what you expected to happen (or insert a code snippet).
+<!-- If you don't know what broke, but have a minimal reproducer, that would be super-helpful helpful! -->
 
-**What did you see instead? Under which circumstances?**
-A clear and concise description of what you expected to happen (or insert a code snippet).
+<!--
 
-**Environment**
-* go version:
+What versions of software are you using?  Specifically, the following are often useful:
 
-<!--- Insert the output of `go version` here -->
+* go version
+* kubebuilder version (`kubebuilder version`) and scaffolding version (check your `PROJECT` file)
+* controller-runtime version (check your `go.mod` file)
+* controller-tools version
+* Kubernetes & kubectl versions (just run `kubectl version` against your API server)
 
-* Kubernetes version information:
-<!--- Insert the output of `kubectl version` here -->
+-->
 
-**Possible Solution**
-<!--- Only if you have suggestions on a fix for the bug -->
+<!-- If this is actually about documentation, add `/kind documentation` below -->
 
-**Additional context**
-Add any other context about the problem here.
\ No newline at end of file
+/kind bug
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index 4b631ec0606..277f660ff20 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,6 +1,6 @@
 ---
 name: Feature request
-about: Suggest an idea for this project
+about: Suggest an idea for this project or its docs
 title: ''
 labels: kind/feature
 assignees: ''
@@ -15,10 +15,24 @@ assignees: ''
 
 -->
 
-/kind feature
+<!-- 
+
+Hiya!  Welcome to KubeBuilder!  For a smooth feature request process, try to
+answer the following questions. Don't worry if they're not all applicable; just
+try to include what you can :-)
+
+If you need to include code snippets or logs, please put them in fenced code
+blocks.  If they're super-long, please use the details tag like
+<details><summary>super-long log</summary> lots of stuff </details>
+
+-->
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Example: "I have an issue when (...)"
+<!-- What do you want to happen? -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen. Add any considered drawbacks.
\ No newline at end of file
+<!-- Is there currently another issue associated with this? -->
+
+<!-- Does it require a particular kubernetes version? -->
+
+<!-- If this is actually about documentation, add `/kind documentation` below -->
+
+/kind feature
diff --git a/.github/ISSUE_TEMPLATE/support-question.md b/.github/ISSUE_TEMPLATE/support-question.md
index 214adf3ebc8..23e282c2fb0 100644
--- a/.github/ISSUE_TEMPLATE/support-question.md
+++ b/.github/ISSUE_TEMPLATE/support-question.md
@@ -2,7 +2,7 @@
 name: Question
 about: Any questions you might have.
 title: ''
-labels: kind/question
+labels: triage/support
 assignees: ''
 
 ---
@@ -15,4 +15,33 @@ assignees: ''
 
 -->
 
-kind question
\ No newline at end of file
+<!-- 
+
+Hiya!  Welcome to KubeBuilder!
+
+You probably didn't want to be one this page.  It shouldn't really be here anyway.
+
+* Double-check the docs https://book.kubebuilder.io and https://godoc.org/sigs.k8s.io/controller-runtime.
+
+* If you want a quick response to a question, ask on the Kubernetes Slack instance in #kubebuilder.
+
+* If this is actually a bug or a feature request, file one of those.  If you're
+  not sure which, just take a guess and we can always re-label.
+
+* If you think this might turn into a bug or feature request, but you're not
+  sure, try asking in Slack first.
+
+-->
+
+<!--
+
+Still here?  Double-check that this hasn't been asked before, then put your question below
+with as many details as possible.
+
+If you need to include code snippets or logs, please put them in fenced code
+blocks.  If they're super-long, please use the details tag like
+<details><summary>super-long log</summary> lots of stuff </details>
+
+-->
+
+/triage support
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index ee20701bd5e..5faf3f6b3b4 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,17 +1,20 @@
 <!--
 
-Note: Make sure your branch is rebased to the latest upstream master.
+Hiya!  Welcome to KubeBuilder!  For a smooth PR process, please ensure
+that you include the following information:
 
--->
-
-**Description of the change:**
+* a description of the change
+* the movtivation for the change
+* what issue it fixes, if any, in GitHub syntax (e.g. Fixes #XYZ)
 
+Both the description and motivation may reference other issues and PRs,
+but should be mostly understandable without following the links (e.g. when
+reading the git commit log).
 
-**Motivation for the change:**
+Please don't @-mention people in PR or commit messages (do so in an
+additional comment).
 
-<!--
+**PLEASE REMOVE THIS COMMENT BLOCK BEFORE SUBMITTING THE PR** (the bits
+between the arrows)
 
-Note: If this PR is fixing an issue make sure to add a note saying:
-Closes #<ISSUE_NUMBER>
-
--->
\ No newline at end of file
+-->