Skip to content

Commit 78f2012

Browse files
zjszjs
committed
Update GitHub issue templates
Introduce a set of issue templates for common types of issues, such as defects, 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).
1 parent 49cf03a commit 78f2012

File tree

6 files changed

+200
-45
lines changed

6 files changed

+200
-45
lines changed

‎.github/ISSUE_TEMPLATE.md

+12-45
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,20 @@
11
<!--
2-
Issues in this repository are for VIC Engine only
2+
This repository is for VIC Engine. Please use it to report issues related to Virtual Container Hosts, Container VMs, and their lifecycles.
33
4-
Issues related to other components should be submitted to their respective projects:
5-
VIC Appliance (OVA): https://github.com/vmware/vic-product/issues
6-
Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
7-
Container Registry (Harbor): https://github.com/vmware/harbor/issues
8-
9-
If you are unsure which component your issue relates to, submit it to https://github.com/vmware/vic-product/issues and we will triage it
10-
11-
Thank you for contributing to VIC Engine! Please review this checklist before submitting your issue.
12-
13-
[ ] Search for duplicates before logging new issues
14-
https://github.com/vmware/vic/issues?q=is%3Aopen+is%3Aissue
15-
[ ] Questions are best asked and answered on Slack
16-
https://vmwarecode.slack.com/messages/vic-engine (see https://github.com/vmware/vic/blob/master/CONTRIBUTING.md#community for details)
4+
To help use keep things organized, please file issues in the most appropriate repository:
5+
* vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
6+
* VIC Appliance (OVA) and User Documentation: https://github.com/vmware/vic-product/issues
7+
* Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
8+
* Container Registry (Harbor): https://github.com/goharbor/harbor/issues
179
-->
1810

19-
#For stories, please include the information below:
20-
21-
**User Statement:**
22-
23-
A brief statement describe who, what and why of the story for example - As a job seeker, I want to search for a job, so I can advance my career.
24-
25-
**Details:**
26-
Any details of what you want that might clarify for the developer how to approach the implementation.
27-
28-
**Acceptance Criteria:**
29-
Specific deliverable and actionable items that the story needs to deliver in order to be considered complete, the more detail here the more accurate the implementation will be.
30-
31-
32-
#For bug reports, please include the information below:
33-
34-
**VIC version:**
35-
36-
x.y.z / master / commit ID
37-
38-
**Deployment details:**
39-
40-
What was the vic-machine create command used to deploy the VCH?
41-
42-
**Steps to reproduce:**
43-
44-
**Actual behavior:**
11+
#### Summary
12+
<!-- Explain the issue briefly. -->
4513

46-
**Expected behavior:**
4714

48-
**Logs:**
15+
#### Details
16+
<!-- Provide additional details. -->
4917

50-
* If you can access the VCH Admin portal, please download and attach the log bundle(s). See https://vmware.github.io/vic/assets/files/html/vic_admin/log_bundles.html for details.
51-
* If the VCH Admin portal is inaccessible, you can enable SSH to the VCH endpoint VM to obtain logs manually. See https://vmware.github.io/vic/assets/files/html/vic_admin/vch_ssh_access.html for details. The VCH logs will be under /var/log/vic/ on the VM.
5218

53-
**Additional details as necessary:**
19+
#### See Also
20+
<!-- Provide references to relevant resources, such as documentation or related issues. -->

‎.github/ISSUE_TEMPLATE/defect.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
name: "Defect Report"
3+
about: Report something that isn't working as expected
4+
5+
---
6+
7+
<!--
8+
This repository is for VIC Engine. Please use it to report issues related to Virtual Container Hosts, Container VMs, and their lifecycles.
9+
10+
To help use keep things organized, please file issues in the most appropriate repository:
11+
* vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
12+
* VIC Appliance (OVA) and User Documentation: https://github.com/vmware/vic-product/issues
13+
* Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
14+
* Container Registry (Harbor): https://github.com/goharbor/harbor/issues
15+
-->
16+
17+
#### Summary
18+
<!-- Explain the problem briefly. -->
19+
20+
21+
#### Environment information
22+
<!-- Describe the environment where the issue occurred. -->
23+
24+
##### vSphere and vCenter Server version
25+
<!-- Indicate the vSphere and vCenter Server version(s) being used. -->
26+
27+
##### VIC version
28+
<!-- Indicate the full VIC version being used (e.g., vX.Y.Z-tag-NNNN-abcdef0). -->
29+
30+
##### VCH configuration
31+
<!-- Provide the settings used to deploy the VCH (e.g., a vic-machine create command). -->
32+
33+
34+
#### Details
35+
<!-- Provide additional details. -->
36+
37+
##### Steps to reproduce
38+
39+
##### Actual behavior
40+
41+
##### Expected behavior
42+
43+
44+
#### Logs
45+
<!--
46+
For issues related to a deployed VCH, please attach a log bundle.
47+
* If you can access the VCH Admin portal, please download and attach the log bundle(s). See https://vmware.github.io/vic/assets/files/html/vic_admin/log_bundles.html for details.
48+
* If the VCH Admin portal is inaccessible, you can enable SSH to the VCH endpoint VM to obtain logs manually. See https://vmware.github.io/vic/assets/files/html/vic_admin/vch_ssh_access.html for details. The VCH logs will be under /var/log/vic/ on the VM.
49+
50+
For issues deploying or managing a VCH, please *also* attach the vic-machine log file.
51+
* When using the vic-machine CLI, the vic-machine.log file is written to your current working directory.
52+
* When using VCH Management API, please download and attach the vic-machine-server.log file. See https://vmware.github.io/vic-product/assets/files/html/1.4/vic_vsphere_admin/appliance_logs.html for details.
53+
-->
54+
55+
56+
#### See also
57+
<!-- Provide references to relevant resources, such as documentation or related issues. -->
58+
59+
60+
#### Troubleshooting attempted
61+
<!-- Use this section to indicate steps you've already taken to troubleshoot the issue. -->
62+
63+
- [ ] Searched [GitHub][issues] for existing issues. (Mention any similar issues under "See also", above.)
64+
- [ ] Searched the [documentation][docs] for relevant troubleshooting guidance.
65+
- [ ] Searched for a relevant [VMware KB article][kb].
66+
67+
<!-- Reference-style links used above; removing these will break the links. -->
68+
[issues]:https://github.com/vmware/vic/issues
69+
[docs]:https://vmware.github.io/vic-product/#documentation
70+
[kb]:https://kb.vmware.com/s/global-search/%40uri#t=Knowledge&sort=relevancy&f:@commonproduct=[vSphere%20Integrated%20Containers]

‎.github/ISSUE_TEMPLATE/feature-request.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: "Feature/Enhancement Request"
3+
about: Request an new feature or enhancement to existing functionality
4+
5+
---
6+
7+
<!--
8+
This repository is for VIC Engine. Please use it to report issues related to Virtual Container Hosts, Container VMs, and their lifecycles.
9+
10+
To help use keep things organized, please file issues in the most appropriate repository:
11+
* vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
12+
* VIC Appliance (OVA) and User Documentation: https://github.com/vmware/vic-product/issues
13+
* Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
14+
* Container Registry (Harbor): https://github.com/goharbor/harbor/issues
15+
-->
16+
17+
#### Summary
18+
<!-- Explain the request briefly. -->
19+
20+
21+
#### User statement(s)
22+
<!--
23+
Brief statement(s) that describe who, what and why. These help the engineer addressing the request better understand the user's point of view.
24+
25+
Optionally, include a nested list of conditions of satisfaction for each statement. These may be added later, shortly before work begins on a request.
26+
27+
Example (from https://www.mountaingoatsoftware.com/agile/user-stories):
28+
* 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.
29+
* Support holidays that span two calendar years (none span three).
30+
* Holiday seasons can be set from one holiday to the next (such as Thanksgiving to Christmas).
31+
* Holiday seasons can be set to be a number of days prior to the holiday.
32+
-->
33+
34+
35+
#### Details
36+
<!-- Provide any additional details that do not fit the above format. -->
37+
38+
39+
#### See also
40+
<!-- Provide references to relevant resources, such as documentation or related issues. -->

‎.github/ISSUE_TEMPLATE/question.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: "Question"
3+
about: Ask a question about the product
4+
5+
---
6+
7+
<!--
8+
This repository is for VIC Engine. Please use it to report issues related to Virtual Container Hosts, Container VMs, and their lifecycles.
9+
10+
To help use keep things organized, please file issues in the most appropriate repository:
11+
* vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
12+
* VIC Appliance (OVA) and User Documentation: https://github.com/vmware/vic-product/issues
13+
* Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
14+
* Container Registry (Harbor): https://github.com/goharbor/harbor/issues
15+
-->
16+
17+
<!--
18+
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.
19+
20+
See https://github.com/vmware/vic/blob/master/CONTRIBUTING.md#community for details.
21+
-->
22+
23+
#### Question
24+
<!-- Explain the question briefly. -->
25+
26+
27+
#### See also
28+
<!-- Provide references to relevant resources, such as documentation or related issues. -->

‎.github/ISSUE_TEMPLATE/security.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: "Security Issue"
3+
about: Product issues with security impact
4+
5+
---
6+
7+
> 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 [email protected]. Please include details on the software and hardware configuration of your system so that we can duplicate the issue being reported.
8+
>
9+
> **Note:** We encourage use of encrypted email. Our public PGP key is found at https://kb.vmware.com/kb/1055.
10+
>
11+
> 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.
12+
>
13+
> In the case of vulnerabilities found in third-party software components used in VMware products, please also notify VMware as described above.
14+
15+
For more information, see https://www.vmware.com/support/policies/security_response.html
16+

‎.github/ISSUE_TEMPLATE/test-failure.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: "Test Failure"
3+
about: Report failure of an automated test
4+
5+
---
6+
7+
<!--
8+
This repository is for VIC Engine. Please use it to report issues related to Virtual Container Hosts, Container VMs, and their lifecycles.
9+
10+
To help use keep things organized, please file issues in the most appropriate repository:
11+
* vSphere Client Plugins: https://github.com/vmware/vic-ui/issues
12+
* VIC Appliance (OVA) and User Documentation: https://github.com/vmware/vic-product/issues
13+
* Container Management Portal (Admiral): https://github.com/vmware/admiral/issues
14+
* Container Registry (Harbor): https://github.com/goharbor/harbor/issues
15+
-->
16+
17+
#### Symptom
18+
<!-- The error message, failure mode, or pattern that indicates this issue. -->
19+
20+
21+
#### Test case(s)
22+
<!-- The test case(s) (including test, suite, and group information) exhibiting this symptom. -->
23+
24+
25+
#### Robot output
26+
<!-- Any command-line output associated with the failure. -->
27+
28+
29+
#### Logs
30+
<!-- A list of failed jobs, with links to relevant logs (e.g., log.html). -->
31+
32+
33+
#### See also
34+
<!-- Provide references to relevant resources, such as documentation or related issues. -->

0 commit comments

Comments
 (0)