@@ -30,8 +30,13 @@ The detailed implementation of the Problem Resolution for the project shall be d
3030Templates
3131---------
3232
33- To create problem reports, the project shall provide the following template: :need: `[[title]]<gd_temp__problem__template> `.
34- An example template for the issue trackings system GitHub can be found here: (to be updated later)
33+ To create problem reports, the project shall provide the content of the following template
34+ in project's selected Issue Tracking System: :need: `[[title]]<gd_temp__problem__template> `.
35+
36+ .. note ::
37+ An example template for the Issue Tracking System in GitHub (`GitHub Issues <https://github.com/features/issues >`_)
38+ can be found here:
39+ `Issue Template Bugfix <https://github.com/eclipse-score/process_description/blob/main/.github/ISSUE_TEMPLATE/1-bugfix.yml >`_
3540
3641Attributes
3742----------
@@ -85,18 +90,51 @@ This section describes in detail which steps need to be performed for a Problem
8590Create Problem Report
8691---------------------
8792
88- :need: `[[title]] <rl__contributor> ` (as author) creates the Problem Report in the defined Issue
89- Tracking System based on the provided template.
90- It is expected, that the UID will be provided by the Issue Tracking System.
93+ :need: `[[title]] <rl__contributor> ` (as author, submitter, reporter) creates the Problem
94+ Report in the defined Issue Tracking System of the project based on the content of the
95+ provided template:
96+ :need: `[[title]]<gd_temp__problem__template> `.
97+
98+ It is expected that the select Issue Tracking system supports template definition. Best
99+ practice is to define a template with the required content, so that it can be copied
100+ from the different users.
101+
102+ .. note ::
103+ For the Issue Tracking System in GitHub, there is a template created, which can be
104+ be found here:
105+ `Issue Template Bugfix <https://github.com/eclipse-score/process_description/blob/main/.github/ISSUE_TEMPLATE/1-bugfix.yml >`_
106+
107+ .. note ::
108+ A Problem Report Example based on that template is here:
109+ `Example Problem Report <https://github.com/eclipse-score/process_description/issues/124 >`_
110+
111+ It is expected, that the UID will be provided automatically by the Issue Tracking System.
112+
113+ It is expected, that the status of the problem report is set to "open" automatically.
114+ As long as the content is updated, the status of the Problem is kept "open".
115+
116+ It is expected, that the problem submitter will be set automatically by the Issue
117+ Tracking System.
91118
92119The title of the Problem Report should reflect the topic accordingly.
93120
94121The description should reflect the problem root cause and impact in detail.
95122
96- Copy therefore the :need: `Problem Template <gd_temp__problem__template> ` into the created Problem
97- Report (Issue Tracking System).
98-
99- Set the status of the Problem to "open", when ready to review and analyze set to "in review".
123+ .. note ::
124+ | For the Problem Report Example:
125+ | * The UID is provided by the Issue Tracking System as: **#124**
126+ | * The status is provided by the Issue Tracking System as: **Open**
127+ | * The submitter is provided by the Issue Tracking System as: **masc2023**
128+ | * The title contains the main root cause, missing safety/security attribute
129+ | * The descriptions has a section for the root cause and impact
130+ | * Further supporting information is added as the link to the official feature request template
131+
132+ When ready to review and to analyze, the reporter sets the status to "in review" manually.
133+
134+ .. note ::
135+ | For the Problem Report Example:
136+ | * The "Process Development Community" dashboard is added and the status must be changed to **Todo**
137+ | * The combination of **Open** and **Todo** defines the status **in review**
100138
101139.. _prm_analyze_problem_report :
102140
0 commit comments