OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
sof/.github/ISSUE_TEMPLATE/bug_report.md

43 lines
1.7 KiB
Markdown
Raw Normal View History

Update issue templates Initial bug report.
2019-04-01 17:13:02 +08:00
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
gh: update issue templates Add section for reproduction rate in bug report template
2019-05-28 20:20:34 +08:00
assignees: ''
Update issue templates Initial bug report.
2019-04-01 17:13:02 +08:00
---
**Describe the bug**
A clear and concise description of what the bug is.
What have you tried to diagnose or workaround this issue?
github: fix link to bug tracking docs Update bug form to point to new location of the document. Signed-off-by: Janusz Jankowski <janusz.jankowski@linux.intel.com>
2020-01-09 10:22:29 +08:00
Please also read https://thesofproject.github.io/latest/contribute/process/bug-tracking.html for further information on submitting bugs.
Update issue templates Initial bug report.
2019-04-01 17:13:02 +08:00
**To Reproduce**
issue_template: remove dead references and duplicate fields reproducibility field is duplicated and soft is archived and no longer needed. Add placeholders for needed system information. Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2019-09-20 05:22:40 +08:00
Steps to reproduce the behavior: (e.g. list commands or actions used to reproduce the bug)
Update issue templates Initial bug report.
2019-04-01 17:13:02 +08:00
gh: update issue templates Add section for reproduction rate in bug report template
2019-05-28 20:20:34 +08:00
**Reproduction Rate**
How often does the issue happen ? i.e. 1/10 (once in ten attempts), 1/1000 or all the time.
Does the reproduction rate vary with any other configuration or user action, if so please describe and show the new reproduction rate.
Update issue templates Initial bug report.
2019-04-01 17:13:02 +08:00
**Expected behavior**
A clear and concise description of what you expected to happen.
**Impact**
What impact does this issue have on your progress (e.g., annoyance, showstopper)
**Environment**
issue_template: remove dead references and duplicate fields reproducibility field is duplicated and soft is archived and no longer needed. Add placeholders for needed system information. Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2019-09-20 05:22:40 +08:00
1) Branch name and commit hash of the 2 repositories: sof (firmware/topology) and linux (kernel driver).
* Kernel: {SHA}
* SOF: {SHA}
Update issue templates Initial bug report.
2019-04-01 17:13:02 +08:00
2) Name of the topology file
issue_template: remove dead references and duplicate fields reproducibility field is duplicated and soft is archived and no longer needed. Add placeholders for needed system information. Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2019-09-20 05:22:40 +08:00
* Topology: {FILE}
Update issue templates Initial bug report.
2019-04-01 17:13:02 +08:00
3) Name of the platform(s) on which the bug is observed.
issue_template: remove dead references and duplicate fields reproducibility field is duplicated and soft is archived and no longer needed. Add placeholders for needed system information. Signed-off-by: Curtis Malainey <cujomalainey@google.com>
2019-09-20 05:22:40 +08:00
* Platform: {PLATFORM}
Update issue templates Initial bug report.
2019-04-01 17:13:02 +08:00
**Screenshots or console output**
If applicable, add a screenshot (drag-and-drop an image), or console logs
(cut-and-paste text and put a code fence (\`\`\`) before and after, to help
explain the issue.
Please also include the relevant sections from the firmware log and kernel log in the report (and attach the full logs for complete reference). Kernel log is taken from *dmesg* and firmware log from *sof-logger*. See https://thesofproject.github.io/latest/developer_guides/debugability/logger/index.html