Skip to content

Commit

Permalink
[docs] add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
MFransen69 committed Mar 25, 2024
1 parent c47fba4 commit 6b7787a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/issuetemplate/issuetemplate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
When you suspect there is an issue in Thunder for which you would like assistance please use the below template to report the issue.

- Symptom (e.g. segmentation fault, hang-up/unresponsive, assert)
- Thunder hash the issue is observed on (and if relevant RDKServices hash and/or hash of any other plugin that plays a role in the reproduction scenario)
- Urgency (low, medium, high) and if medium/high reason for this urgency
- Jira issue(s) already created that are relevant for the issue
- Which component is suspected to cause this (if known provide the process including its startup parameters)
- If possible a callstack the moment the issue happened of all threads
- If possible a memory usage overview of the device the moment the issue happened (e.g using top)
- Detailed Description of the issue
- Reproduction scenario of the issue on a device with a minimal setup (e.g. Thunder with a maximum of one or two plugins) and using a Thunder build without any patches and also no patches on any other code, e.g. plugins). Including:
- build steps if relevant (preferably a build we can reproduce ourselves, but also info on build settings like debug or release, optimization level etc. Anything that is relevant)
- device if relevant (ideally it can be reproduced on any device, e.g. RPi)
- detailed reproduction scenario describing the steps to take in what order and the symptoms of the issue to observe
- Whom to contact in case of questions
- any other info that could be relevant

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ nav:
- Misc:
- Documentation: docs.md
- References: references/references.md
- Filing an Issue: issuetemplate/issuetemplate.md


markdown_extensions:
Expand Down

0 comments on commit 6b7787a

Please sign in to comment.