summaryrefslogtreecommitdiff
path: root/.github/ISSUE_TEMPLATE/bug_report.yml
diff options
context:
space:
mode:
authorEd Tanous <edtanous@google.com>2023-08-10 00:37:14 +0300
committerEd Tanous <ed@tanous.net>2023-08-15 01:47:26 +0300
commit9bcb9355b848970d62606b7f4e167329072406c1 (patch)
tree73fae5be07961906f436a902ee5881fe7c160494 /.github/ISSUE_TEMPLATE/bug_report.yml
parent64466c0a89aa0c9ce78d1ad05f49abc257e27051 (diff)
downloadbmcweb-9bcb9355b848970d62606b7f4e167329072406c1.tar.xz
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>
Diffstat (limited to '.github/ISSUE_TEMPLATE/bug_report.yml')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml55
1 files changed, 55 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000000..95d1f3d08b
--- /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.