From 6b7787a03573e645e3e31c104ea88f7e40fed636 Mon Sep 17 00:00:00 2001 From: Marcel Fransen Date: Mon, 25 Mar 2024 13:20:41 +0100 Subject: [PATCH] [docs] add issue template --- docs/issuetemplate/issuetemplate.md | 17 +++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 18 insertions(+) create mode 100644 docs/issuetemplate/issuetemplate.md diff --git a/docs/issuetemplate/issuetemplate.md b/docs/issuetemplate/issuetemplate.md new file mode 100644 index 000000000..79c6998ca --- /dev/null +++ b/docs/issuetemplate/issuetemplate.md @@ -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 + diff --git a/mkdocs.yml b/mkdocs.yml index 85117a113..4b01b373c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,6 +68,7 @@ nav: - Misc: - Documentation: docs.md - References: references/references.md + - Filing an Issue: issuetemplate/issuetemplate.md markdown_extensions: