Skip to content

Commit d6e7a4f

Browse files
authored
Proposal for new issue template for sonic-mgmt (sonic-net#12559)
This PR proposes a new issue template for this project. The new issue template moves away from the legacy format. The new has clearer sections for a bug report. Any suggestions regarding the template are welcome.
1 parent 33ae470 commit d6e7a4f

File tree

3 files changed

+85
-62
lines changed

3 files changed

+85
-62
lines changed

.github/ISSUE_TEMPLATE.md

-62
This file was deleted.
+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: Test Case Bug Report
2+
description: File a bug report for a test case.
3+
title: "[Bug]: "
4+
labels: ["bug", "triage", "testcase"]
5+
projects: ["sonic-mgmt"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for taking the time to fill out this bug report!
11+
12+
If you are reporting a new issue, make sure that we do not have any duplicates already open. You can ensure this by searching the issue list for this repository. If there is a duplicate, please close your issue and add a comment to the existing issue instead.
13+
14+
If you suspect your issue is a bug, please edit your issue description to include the BUG REPORT INFORMATION shown below. If you fail to provide this information within 7 days, we cannot debug your issue and will close it. We will however, reopen it if you later provide the information.
15+
16+
For more information about reporting issues, see [SONiC Issue Reporting Page](https://github.com/sonic-net/SONiC/wiki#report-issues)
17+
- type: markdown
18+
id: tc-contact-links
19+
attributes:
20+
value: |
21+
Please ask and answer questions here at the [SONiC Support Forums](https://groups.google.com/forum/#!forum/sonicproject)
22+
- type: textarea
23+
id: tc-description
24+
attributes:
25+
label: Issue Description
26+
description: What happened?
27+
placeholder: Describe the issue and step to reproduce the issue
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: tc-results
32+
attributes:
33+
label: Results you see
34+
description: Results you see
35+
placeholder: Describe the results you saw
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: tc-expected-results
40+
attributes:
41+
label: Results you expected to see
42+
description: Results you expected to see
43+
placeholder: Describe the results you expected to see
44+
validations:
45+
required: true
46+
- type: dropdown
47+
id: tc-platform
48+
attributes:
49+
label: Is it platform specific
50+
description: Platform name
51+
options:
52+
- generic
53+
- barefoot
54+
- broadcom
55+
- cavium
56+
- centec
57+
- innovium
58+
- marvell
59+
- mellanox
60+
- nephos
61+
default: 0
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: tc-logs
66+
attributes:
67+
label: Relevant log output
68+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
69+
render: shell
70+
- type: textarea
71+
id: tc-output
72+
attributes:
73+
label: Output of `show version`
74+
description: Please copy and paste output of `show version`. This will be automatically formatted into code, so no need for backticks
75+
render: shell
76+
- type: markdown
77+
id: tc-attach-logs
78+
attributes:
79+
value: |
80+
Attach debug file (if any) from: `sudo generate_dump` or other logs.
81+
- type: textarea
82+
id: tc-attachments
83+
attributes:
84+
label: Attach files (if any)

.github/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)