Add separate issue templates for bug, enhancement, test gap and regression (sonic-net#17310)

opcoder0 · web-flow · commit 9dd47e007108 · 2025-03-05T15:25:28.000+08:00
Add a separate issue template for Bug, Enhancement, Test Gap, Regression. What is the motivation for this PR? Enhance issue template. How did you do it? Modify issue template How did you verify/test it? https://github.com/opcoder0/sonic-mgmt-issue/issues
diff --git a/.github/ISSUE_TEMPLATE/01-bug.yml b/.github/ISSUE_TEMPLATE/01-bug.yml
@@ -1,7 +1,7 @@
-name: Issue Report for Bug, Enhancement or Test Gap
-description: File a test gap, bug report or enhancement for a test case.
-title: "[Bug|Enhancement|Test Gap]:"
-labels: []
+name: Report a bug
+description: File a bug report
+title: "Bug:"
+labels: ['Bug']
 projects: ["sonic-mgmt"]
 body:
   - type: markdown
@@ -14,106 +14,90 @@ body:
         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.
 
         For more information about reporting issues, see [SONiC Issue Reporting Page](https://github.com/sonic-net/SONiC/wiki#report-issues)
+
   - type: markdown
-    id: tc-contact-links
+    id: tc-bug-contact-links
     attributes:
       value: |
         Please ask and answer questions here at the [SONiC Support Forums](https://groups.google.com/forum/#!forum/sonicproject)
+
   - type: dropdown
-    id: tc-issue-type
+    id: tc-bug-platform
     attributes:
-      label: Issue Type
+      label: Is it platform specific
+      description: Platform name
       options:
-        - Test Gap
-        - Bug Report
-        - Enhancement
+        - generic
+        - barefoot
+        - broadcom
+        - cavium
+        - centec
+        - innovium
+        - marvell
+        - mellanox
+        - nephos
+      default: 0
     validations:
       required: true
-  - type: textarea
-    id: tc-description
+
+  - type: dropdown
+    id: tc-bug-severity
     attributes:
-      label: Description
-      description: Description of the bug, test gap or enhancement
-      placeholder: Description of the bug, test gap or enhancement
+      label: Importance or Severity
+      options:
+        - Critical
+        - High
+        - Medium
+        - Low
     validations:
       required: true
-  - type: markdown
-    id: tc-note-1
-    attributes:
-      value: |
-        ## Field information:
-          - For a **Bug Report** provide **Steps to Reproduce** the issue
-          - For a **Test Gap** provide **Affected Area**
-          - For an **Enhancement** provide **Current Behavior**
+
   - type: textarea
-    id: tc-step-area-cb
+    id: tc-bug-description
     attributes:
-      label: Issue Details
-      description: Issue Details
+      label: Description of the bug
+      description: Description of the bug
+      placeholder: Description of the bug
     validations:
       required: true
-  - type: markdown
-    id: tc-note-2
-    attributes:
-      value: |
-        ## Field information:
-          - For a **Bug Report** provide the **Actual and expected behavior**
-          - For a **Test Gap** provide **Impact of missing tests and proposed tests**
-          - For an **Enhancement** provide **Proposed Behavior and use case**
+
   - type: textarea
-    id: tc-eb-impact-pb
+    id: tc-bug-steps-to-reproduce
     attributes:
-      label: Impact or Proposed Behavior
-      description: Impact or Proposed Behavior
+      label: Steps to Reproduce
+      description: Steps to Reproduce
     validations:
       required: true
-  - type: dropdown
-    id: tc-severity
-    attributes:
-      label: Importance or Severity
-      options:
-        - Critical
-        - High
-        - Medium
-        - Low
-    validations:
-      required: true
-  - type: dropdown
-    id: tc-platform
+
+  - type: textarea
+    id: tc-bug-actual-behavior-expected-behavior
     attributes:
-      label: Is it platform specific
-      description: Platform name
-      options:
-        - generic
-        - barefoot
-        - broadcom
-        - cavium
-        - centec
-        - innovium
-        - marvell
-        - mellanox
-        - nephos
-      default: 0
+      label: Actual Behavior and Expected Behavior
+      description: Actual Behavior and Expected Behavior
     validations:
       required: true
+
   - type: textarea
-    id: tc-logs
+    id: tc-bug-logs
     attributes:
       label: Relevant log output
       description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
       render: shell
+
   - type: textarea
-    id: tc-output
+    id: tc-bug-output
     attributes:
       label: Output of `show version`
       description: Please copy and paste output of `show version`. This will be automatically formatted into code, so no need for backticks
       render: shell
+
   - type: markdown
-    id: tc-attach-logs
+    id: tc-bug-attach-logs
     attributes:
       value: |
         Attach debug file (if any) from: `sudo generate_dump` or other logs.
+
   - type: textarea
-    id: tc-attachments
+    id: tc-bug-attachments
     attributes:
       label: Attach files (if any)
diff --git a/.github/ISSUE_TEMPLATE/02-enhancement.yml b/.github/ISSUE_TEMPLATE/02-enhancement.yml
@@ -0,0 +1,67 @@
+name: Enhancement Request
+description: Enhancement Request
+title: "Enhancement:"
+labels: ['Enhancement']
+projects: ["sonic-mgmt"]
+body:
+  - type: markdown
+    id: tc-en-contact-links
+    attributes:
+      value: |
+        If you have questions about a product feature please ask and answer questions here at the [SONiC Support Forums](https://groups.google.com/forum/#!forum/sonicproject)
+
+  - type: dropdown
+    id: tc-en-platform
+    attributes:
+      label: Is it platform specific
+      description: Platform name
+      options:
+        - generic
+        - barefoot
+        - broadcom
+        - cavium
+        - centec
+        - innovium
+        - marvell
+        - mellanox
+        - nephos
+      default: 0
+    validations:
+      required: true
+
+  - type: dropdown
+    id: tc-en-severity
+    attributes:
+      label: Importance or Severity
+      options:
+        - Critical
+        - High
+        - Medium
+        - Low
+    validations:
+      required: true
+
+  - type: textarea
+    id: tc-en-description
+    attributes:
+      label: Description of the enhancement
+      description: Description of the enhancement
+      placeholder: Description of the enhancement
+    validations:
+      required: true
+
+  - type: textarea
+    id: tc-en-cb
+    attributes:
+      label: Current Behavior
+      description: Current Behavior
+    validations:
+      required: true
+
+  - type: textarea
+    id: tc-en-pb
+    attributes:
+      label: Proposed Behavior
+      description: Proposed Behavior
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/03-testgap.yml b/.github/ISSUE_TEMPLATE/03-testgap.yml
@@ -0,0 +1,60 @@
+name: Report a Test Gap
+description: Report a Test Gap
+title: "Test Gap:"
+labels: ["Test gap"]
+projects: ["sonic-mgmt"]
+body:
+  - type: dropdown
+    id: tc-tg-platform
+    attributes:
+      label: Is it platform specific
+      description: Platform name
+      options:
+        - generic
+        - barefoot
+        - broadcom
+        - cavium
+        - centec
+        - innovium
+        - marvell
+        - mellanox
+        - nephos
+      default: 0
+    validations:
+      required: true
+
+  - type: dropdown
+    id: tc-tg-severity
+    attributes:
+      label: Importance or Severity
+      options:
+        - Critical
+        - High
+        - Medium
+        - Low
+    validations:
+      required: true
+
+  - type: textarea
+    id: tc-tg-description
+    attributes:
+      label: Description of the test gap
+      description: Description of the test gap
+    validations:
+      required: true
+
+  - type: textarea
+    id: tc-tg-aa
+    attributes:
+      label: Affected Area
+      description: Affected Area
+    validations:
+      required: true
+
+  - type: textarea
+    id: tc-tg-impact-pb
+    attributes:
+      label: Impact of missing tests and proposed tests
+      description: Impact of missing tests and proposed tests
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/04-regression.yml b/.github/ISSUE_TEMPLATE/04-regression.yml
@@ -0,0 +1,96 @@
+name: Report a regression
+description: Report a regression issue
+title: "Regression:"
+labels: [regression, Bug]
+projects: ["sonic-mgmt"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this report!
+
+        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.
+
+        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.
+
+        For more information about reporting issues, see [SONiC Issue Reporting Page](https://github.com/sonic-net/SONiC/wiki#report-issues)
+
+  - type: dropdown
+    id: tc-reg-platform
+    attributes:
+      label: Is it platform specific
+      description: Platform name
+      options:
+        - generic
+        - barefoot
+        - broadcom
+        - cavium
+        - centec
+        - innovium
+        - marvell
+        - mellanox
+        - nephos
+      default: 0
+    validations:
+      required: true
+
+  - type: dropdown
+    id: tc-reg-severity
+    attributes:
+      label: Importance or Severity
+      options:
+        - Critical
+        - High
+        - Medium
+        - Low
+    validations:
+      required: true
+
+  - type: input
+    id: tc-reg-previous-working-version
+    attributes:
+      label: Previous Working Version
+      description: Specify the last known version where the functionality worked as expected
+      placeholder: e.g., 202311 or Git SHA
+    validations:
+      required: true
+
+  - type: textarea
+    id: tc-reg-str
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to Reproduce
+    validations:
+      required: true
+
+  - type: textarea
+    id: tc-reg-impact
+    attributes:
+      label: Impact of this regression
+      description: Impact of this regression
+    validations:
+      required: true
+
+  - type: textarea
+    id: tc-reg-logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+
+  - type: textarea
+    id: tc-reg-output
+    attributes:
+      label: Output of `show version`
+      description: Please copy and paste output of `show version`. This will be automatically formatted into code, so no need for backticks
+      render: shell
+
+  - type: markdown
+    id: tc-reg-attach-logs
+    attributes:
+      value: |
+        Attach debug file (if any) from: `sudo generate_dump` or other logs.
+  - type: textarea
+    id: tc-reg-attachments
+    attributes:
+      label: Attach files (if any)
diff --git a/.github/workflows/apply-label.yml b/.github/workflows/apply-label.yml
