From 125712baf87bffdbab321e161b886eef0cc62fe8 Mon Sep 17 00:00:00 2001
From: Zach Shepherd <zjs@users.noreply.github.com>
Date: Tue, 13 Nov 2018 00:00:05 +0100
Subject: [PATCH] Update GitHub issue templates (#2100)

Introduce a set of issue templates for common types of issues, such as
defects, documentation feedback, feature requests, questions, and test
failures. Additionally, introduce a issue template for security issues
that directs users to VMware's official security response policy.

Revise default template to be more appropriate for more issues that do
not fall into any of these categories (e.g., infrastructure issues and
tasks).
---
 .github/ISSUE_TEMPLATE.md                 | 71 ++++---------------
 .github/ISSUE_TEMPLATE/defect.md          | 86 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/documentation.md   | 22 ++++++
 .github/ISSUE_TEMPLATE/feature-request.md | 40 +++++++++++
 .github/ISSUE_TEMPLATE/question.md        | 28 ++++++++
 .github/ISSUE_TEMPLATE/security.md        | 16 +++++
 .github/ISSUE_TEMPLATE/test-failure.md    | 34 +++++++++
 7 files changed, 238 insertions(+), 59 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/defect.md
 create mode 100644 .github/ISSUE_TEMPLATE/documentation.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md
 create mode 100644 .github/ISSUE_TEMPLATE/question.md
 create mode 100644 .github/ISSUE_TEMPLATE/security.md
 create mode 100644 .github/ISSUE_TEMPLATE/test-failure.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index ce481e221f..1194d4b098 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,67 +1,20 @@
 <!--
-Issues in this repository are for VIC Product (VIC appliance)
+This repository is for VIC Product. Please use it to report issues related to the VIC Appliance (OVA) and user documentation.
 
-Before submitting an issue, please read the troubleshooting guide
-https://github.com/vmware/vic-product/blob/master/installer/docs/SUPPORT.md
-
-Issues related to individual components should be submitted to their respective projects:
-- VIC Engine: https://github.com/vmware/vic/issues
-- Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
-- Container Registry (Harbor): https://github.com/vmware/harbor/issues
-
-If you are unsure which component your issue relates to, submit it here and we will triage it
-Thank you for contributing to VIC Product!
+To help use keep things organized, please file issues in the most appropriate repository:
+ * vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
+ * VIC Engine (VCHs, Container VMs, and their lifecycles): https://github.com/vmware/vic/issues
+ * Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
+ * Container Registry (Harbor): https://github.com/goharbor/harbor/issues
 -->
 
-##### For bug reports, please include the information below:
-
-Please fill out both the Basic Information and Detailed Information sections.
-
-Bug Report Basic Information
-----------------------------
-
-REQUIRED:
-
-- vCenter Server version:
-- Embedded or external PSC:
-- Filename of the OVA you deployed:
-- How was the OVA deployed? (Flex client, HTML5 client, ovftool):
-- Does the VIC appliance recieve configuration by DHCP?
-- What stage of the Appliance Lifecycle is the VIC appliance in?
-  https://github.com/vmware/vic-product/blob/master/installer/docs/SUPPORT.md#appliance-lifecycle
-- Attach the VIC appliance support bundle (e.g. vic_appliance_logs_2018-01-01-00-01-00.tar.gz)
-  https://github.com/vmware/vic-product/blob/master/installer/docs/SUPPORT.md#appliance-support-bundle
-  Note: The support bundle may contain private information. If you are not comfortable with posting this publicly, please contact VMware GSS.
-
-OPTIONAL, but helpful:
-
-- IP address of VIC appliance:
-- Hostname of VIC appliance:
-- IP address of vCenter Server:
-- Hostname of vCenter Server:
-
-
-Bug Report Detailed Information
--------------------------------
-
-- What operation was being performed when the failure was noticed?
-
-- Provide information from the `Support Information` section of the appropriate Appliance Lifecycle stage:
-  https://github.com/vmware/vic-product/blob/master/installer/docs/SUPPORT.md#appliance-lifecycle
-
-- Provide additional detail as necessary:
-
-
-
-
-
-
-
+#### Summary
+<!-- Explain the issue briefly. -->
 
-##### For feature requests/user stories, please include the information below:
 
-**User Statement:**
+#### Details
+<!-- Provide additional details. -->
 
-**Details:**
 
-**Acceptance Criteria:**
+#### See Also
+<!-- Provide references to relevant resources, such as documentation or related issues. -->
diff --git a/.github/ISSUE_TEMPLATE/defect.md b/.github/ISSUE_TEMPLATE/defect.md
new file mode 100644
index 0000000000..608755042f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/defect.md
@@ -0,0 +1,86 @@
+---
+name: "Defect Report"
+about: Report something that isn't working as expected
+
+---
+
+<!--
+This repository is for VIC Product. Please use it to report issues related to the VIC Appliance (OVA) and user documentation.
+
+To help use keep things organized, please file issues in the most appropriate repository:
+ * vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
+ * VIC Engine (VCHs, Container VMs, and their lifecycles): https://github.com/vmware/vic/issues
+ * Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
+ * Container Registry (Harbor): https://github.com/goharbor/harbor/issues
+-->
+
+#### Summary
+<!-- Explain the problem briefly. -->
+
+
+#### Environment information
+<!-- Describe the environment where the issue occurred. -->
+
+##### vSphere and vCenter Server version
+<!-- Indicate the vSphere and vCenter Server version(s) being used. -->
+
+##### VIC Appliance version
+<!-- Indicate the full filename of the VIC Appliance version that you deployed (e.g., vic-vX.Y.Z-tag-NNNN-abcdef0.ova). -->
+
+##### Configuration
+
+- Embedded or external PSC:
+- How was the OVA deployed? (Flex client, HTML5 client, ovftool):
+- Does the VIC appliance recieve configuration by DHCP?
+- What [stage of the Appliance Lifecycle][1] is the VIC appliance in?
+<!-- OPTIONAL, but helpful: -->
+- IP address of VIC appliance:
+- Hostname of VIC appliance:
+- IP address of vCenter Server:
+- Hostname of vCenter Server:
+
+[1]:https://github.com/vmware/vic-product/blob/master/installer/docs/SUPPORT.md#appliance-lifecycle
+
+
+#### Details
+<!-- Provide additional details. -->
+
+##### Steps to reproduce
+<!-- What operation was being performed when the failure was noticed? -->
+
+##### Actual behavior
+<!-- What happend? -->
+
+##### Expected behavior
+<!-- What did you expect to happen instead? -->
+
+##### Support information
+<!--
+Provide information from the "Support Information" section of the appropriate Appliance Lifecycle stage:
+  https://github.com/vmware/vic-product/blob/master/installer/docs/SUPPORT.md#appliance-lifecycle
+-->
+
+
+#### Logs
+<!--
+For issues related to the VIC appliance, please attach a log bundle (e.g. vic_appliance_logs_2018-01-01-00-01-00.tar.gz).
+  https://github.com/vmware/vic-product/blob/master/installer/docs/SUPPORT.md#appliance-support-bundle
+  Note: The support bundle may contain private information. If you are not comfortable with posting this publicly, please contact VMware GSS.
+-->
+
+
+#### See also
+<!-- Provide references to relevant resources, such as documentation or related issues. -->
+
+
+#### Troubleshooting attempted
+<!-- Use this section to indicate steps you've already taken to troubleshoot the issue. -->
+
+- [ ] Searched [GitHub][issues] for existing issues. (Mention any similar issues under "See also", above.)
+- [ ] Searched the [documentation][docs] for relevant troubleshooting guidance.
+- [ ] Searched for a relevant [VMware KB article][kb].
+
+<!-- Reference-style links used above; removing these will break the links. -->
+[issues]:https://github.com/vmware/vic-product/issues
+[docs]:https://vmware.github.io/vic-product/#documentation
+[kb]:https://kb.vmware.com/s/global-search/%40uri#t=Knowledge&sort=relevancy&f:@commonproduct=[vSphere%20Integrated%20Containers]
diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md
new file mode 100644
index 0000000000..ec5a71a3f5
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/documentation.md
@@ -0,0 +1,22 @@
+---
+name: "Documentation Feedback"
+about: Suggest a change or improvement to the product documentation
+
+---
+
+#### Summary
+<!-- Explain the feedback briefly. -->
+
+
+#### Details
+<!-- Provide additional details. -->
+
+##### Section reference(s)
+<!-- Provide link(s) to the section(s) of the documentation this feedback applies to. -->
+
+##### Product version(s)
+<!-- What product version(s) does this feedback apply to? -->
+
+
+#### See also
+<!-- Provide references to relevant resources, such as other documentation or related issues. -->
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
new file mode 100644
index 0000000000..f0daebc565
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,40 @@
+---
+name: "Feature/Enhancement Request"
+about: Request an new feature or enhancement to existing functionality 
+
+---
+
+<!--
+This repository is for VIC Product. Please use it to report issues related to the VIC Appliance (OVA) and user documentation.
+
+To help use keep things organized, please file issues in the most appropriate repository:
+ * vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
+ * VIC Engine (VCHs, Container VMs, and their lifecycles): https://github.com/vmware/vic/issues
+ * Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
+ * Container Registry (Harbor): https://github.com/goharbor/harbor/issues
+-->
+
+#### Summary
+<!-- Explain the request briefly. -->
+
+
+#### User statement(s)
+<!--
+Brief statement(s) that describe who, what and why. These help the engineer addressing the request better understand the user's point of view.
+
+Optionally, include a nested list of conditions of satisfaction for each statement. These may be added later, shortly before work begins on a request.
+
+Example (from https://www.mountaingoatsoftware.com/agile/user-stories):
+ * As a vice president of marketing, I want to select a holiday season to be used when reviewing the performance of past advertising campaigns so that I can identify profitable ones.
+    * Support holidays that span two calendar years (none span three).
+    * Holiday seasons can be set from one holiday to the next (such as Thanksgiving to Christmas).
+    * Holiday seasons can be set to be a number of days prior to the holiday.
+-->
+
+
+#### Details
+<!-- Provide any additional details that do not fit the above format. -->
+
+
+#### See also
+<!-- Provide references to relevant resources, such as documentation or related issues. -->
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 0000000000..19940bc920
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,28 @@
+---
+name: "Question"
+about: Ask a question about the product
+
+---
+
+<!--
+This repository is for VIC Product. Please use it to report issues related to the VIC Appliance (OVA) and user documentation.
+
+To help use keep things organized, please file issues in the most appropriate repository:
+ * vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
+ * VIC Engine (VCHs, Container VMs, and their lifecycles): https://github.com/vmware/vic/issues
+ * Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
+ * Container Registry (Harbor): https://github.com/goharbor/harbor/issues
+-->
+
+<!--
+NOTE: Our public Slack channel is often a better way to ask questions and get answers. Consider trying that first, before opening a GitHub issue.
+
+See https://github.com/vmware/vic/blob/master/CONTRIBUTING.md#community for details.
+-->
+
+#### Question
+<!-- Explain the question briefly. -->
+
+
+#### See also
+<!-- Provide references to relevant resources, such as documentation or related issues. -->
diff --git a/.github/ISSUE_TEMPLATE/security.md b/.github/ISSUE_TEMPLATE/security.md
new file mode 100644
index 0000000000..44a5d8992e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/security.md
@@ -0,0 +1,16 @@
+---
+name: "Security Issue"
+about: Product issues with security impact
+
+---
+
+> VMware encourages users who become aware of a security vulnerability in VMware products to contact VMware with details of the vulnerability. VMware has established an email address that should be used for reporting a vulnerability. Please send descriptions of any vulnerabilities found to security@vmware.com. Please include details on the software and hardware configuration of your system so that we can duplicate the issue being reported.
+> 
+> **Note:** We encourage use of encrypted email. Our public PGP key is found at https://kb.vmware.com/kb/1055.
+> 
+> VMware hopes that users encountering a new vulnerability will contact us privately as it is in the best interests of our customers that VMware has an opportunity to investigate and confirm a suspected vulnerability before it becomes public knowledge.
+> 
+> In the case of vulnerabilities found in third-party software components used in VMware products, please also notify VMware as described above.
+
+For more information, see https://www.vmware.com/support/policies/security_response.html
+
diff --git a/.github/ISSUE_TEMPLATE/test-failure.md b/.github/ISSUE_TEMPLATE/test-failure.md
new file mode 100644
index 0000000000..2e15fccb33
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/test-failure.md
@@ -0,0 +1,34 @@
+---
+name: "Test Failure"
+about: Report failure of an automated test
+
+---
+
+<!--
+This repository is for VIC Product. Please use it to report issues related to the VIC Appliance (OVA) and user documentation.
+
+To help use keep things organized, please file issues in the most appropriate repository:
+ * vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
+ * VIC Engine (VCHs, Container VMs, and their lifecycles): https://github.com/vmware/vic/issues
+ * Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
+ * Container Registry (Harbor): https://github.com/goharbor/harbor/issues
+-->
+
+#### Symptom
+<!-- The error message, failure mode, or pattern that indicates this issue. -->
+
+
+#### Test case(s)
+<!-- The test case(s) (including test, suite, and group information) exhibiting this symptom. -->
+
+
+#### Robot output
+<!-- Any command-line output associated with the failure. -->
+
+
+#### Logs
+<!-- A list of failed jobs, with links to relevant logs (e.g., log.html). -->
+
+
+#### See also
+<!-- Provide references to relevant resources, such as documentation or related issues. -->