Update bug template to yaml
Yaml gives more configurability, and the ability to better enforce our
template, hopefully helping get more defined bug reports.
Tested:
This commit is hosted here:
https://github.com/edtanous/bmcweb/issues/new/choose
To give a better idea of how the template works.
Change-Id: I3a76b2762cf1a285eca75b67878b5a6ab2c2011a
Signed-off-by: Ed Tanous <edtanous@google.com>
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 532af8e..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,24 +0,0 @@
----
-name: Bug report
-about: Create a report
-title: ""
-labels: ""
-assignees: ""
----
-
-**Describe the bug** A clear and concise description of what the bug is.
-
-**Environment** What OpenBMC platform was this found on? If this was tested in
-QEMU, please add
-
-What specific OpenBMC versions (SHA1) did you use? (note, SHA1 should be
-resolvable to <https://github.com/openbmc/openbmc>)
-
-**To Reproduce** Steps to reproduce the behavior:
-
-1. Run the command '....'
-2. See error
-3. Expected behavior was '....'
-
-**Is this a regression** Has this behavior worked in the past? If yes, on which
-commit did it work, and what commit was broken?
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..95d1f3d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,55 @@
+name: Bug report
+description: Report a bug to help us improve bmcweb
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Thanks for taking the time to fill out this bug report!
+ - type: checkboxes
+ id: security-check
+ attributes:
+ label: Is this the right place to submit this?
+ description: |-
+ This is used to report product bugs:
+ To report a security vulnerability, please follow <https://github.com/openbmc/docs/blob/master/security/obmc-security-response-team.md>.
+ Any crashes are potentially security vulnerabilities and should be treated as such.
+ To ask questions about how to use OpenBMC, please visit <https://discord.gg/69Km47zH98>.
+ options:
+ - label: "This is not a security vulnerability or a crashing bug"
+ required: true
+ - label: "This is not a question about how to use OpenBMC"
+ required: true
+ - label:
+ "This is not a bug in an OpenBMC fork or a bug in code still
+ under code review."
+ - label: "This is not a request for a new feature."
+ required: true
+ - type: textarea
+ id: bug-description
+ attributes:
+ label: Bug Description
+ description: Tell us what issues you ran into.
+ placeholder:
+ Include information about what you tried, what you expected to
+ happen, and what actually happened. The more details, the better!
+ validations:
+ required: true
+ - type: textarea
+ id: version
+ attributes:
+ label: Version
+ description: Include the SHA1 of OpenBMC you used.
+ placeholder:
+ Include the contents of /etc/os-release. Please ensure that the
+ bug is not reported against anything that has "-dirty" in the
+ version.
+ render: Text
+ validations:
+ required: true
+ - type: textarea
+ id: additional-info
+ attributes:
+ label: Additional Information
+ description: |
+ Please ensure you have collected the relevant debugging information manually and attached below; Was this machine QEMU? What machine was this found on?
+ issue without enough information will not be resolvable.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..71791dd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,9 @@
+contact_links:
+ - name: "Feature"
+ url: https://github.com/openbmc/openbmc/issues
+ about: "Please file any feature requests to the main openbmc project."
+ - name: "Crash bug"
+ url: https://https://github.com/openbmc/docs/blob/master/security/obmc-security-response-team.md
+ about:
+ "Please file any bug causing a crash to
+ openbmc-security@lists.ozlabs.org."
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
deleted file mode 100644
index e3c7a81..0000000
--- a/.github/ISSUE_TEMPLATE/custom.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-name: Custom issue template
-about: Question
-title: ""
-labels: ""
-assignees: ""
----
-
-Please do not use GitHub issues for submitting questions. Please submit your
-questions either to the OpenBMC mailing list, or to the OpenBMC discord channel.
-
-<https://github.com/openbmc/docs/blob/master/README.md#contact>
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 60e1e07..0000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,11 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ""
-labels: ""
-assignees: ""
----
-
-Please do not submit feature requests to GitHub. Please indicate your interest
-in particular projects or features on the mailing list at
-<https://lists.ozlabs.org/listinfo/openbmc>