Skip to content

Commit cb24efa

Browse files
committed
resolve audit findings for problem resolution
Add example using the new issue template Resolves: #86
1 parent 45209da commit cb24efa

File tree

3 files changed

+67
-31
lines changed

3 files changed

+67
-31
lines changed

process/process_areas/problem_resolution/guidance/problem_resolution_guideline.rst

Lines changed: 47 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,13 @@ The detailed implementation of the Problem Resolution for the project shall be d
3030
Templates
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

3641
Attributes
3742
----------
@@ -85,18 +90,51 @@ This section describes in detail which steps need to be performed for a Problem
8590
Create 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

92119
The title of the Problem Report should reflect the topic accordingly.
93120

94121
The 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

process/process_areas/problem_resolution/guidance/problem_resolution_template.rst

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,31 +22,27 @@ Problem Report Template
2222
:status: draft
2323
:complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP2, std_req__aspice_40__SUP-9-BP3, std_req__aspice_40__SUP-9-BP4,
2424

25-
Will be reworked, after this PR with ISSUE_TEMPLATES is merged
26-
2725
Problem status
2826
--------------
2927
[“open”, “in review”, “in implementation”, “closed”, “rejected”]
3028

3129
If possible, use for problem status the properties of the selected Issue Tracking System.
32-
(Update here with example from GitHub, after this PR is merged)
3330

3431
| (to be filled out during :need:`wf__problem__create_pr`)
3532
| (to be updated during :need:`wf__problem__analyze_pr`)
3633
| (to be updated during :need:`wf__problem__initiate_monitor_pr`)
34+
| (to be updated during :need:`wf__problem__close_pr`)
3735
3836
Problem submitter
3937
-----------------
4038
[Who is the reporter of the problem?]
4139

4240
If possible, use for problem submitter the properties of the selected Issue Tracking System
43-
(for implementation see here: to be update with Example later)
4441

4542
(to be filled out during :need:`wf__problem__create_pr`)
4643

4744
Problem description
4845
-------------------
49-
5046
[What is the problem?]
5147

5248
| Determine the cause of the problem, if possible.
@@ -61,7 +57,8 @@ Problem supporting information
6157

6258
[How to reproduce the problem?]
6359

64-
(to be filled out during :need:`wf__problem__create_pr`)
60+
| (to be filled out during :need:`wf__problem__create_pr`)
61+
| (to be updated during :need:`wf__problem__analyze_pr`)
6562
6663
Problem analysis results
6764
------------------------
@@ -81,9 +78,8 @@ Problem stakeholder
8178
Add affected feature, if possible
8279

8380
If possible, use for problem stakeholder the properties of the selected Issue Tracking System
84-
(Update here with example from GitHub, after this PR is merged)
8581

86-
(to be filled out during :need:`wf__problem__create_pr`)
82+
(to be updated during :need:`wf__problem__analyze_pr`)
8783

8884
Problem category
8985
----------------
@@ -97,7 +93,6 @@ Problem category
9793
Safety, Security: Additional qualifier to highlight, if safety or security is affected
9894

9995
If possible, use for problem category the properties of the selected Issue Tracking System
100-
(Update here with example from GitHub, after this PR is merged)
10196

10297
(to be filled out during :need:`wf__problem__create_pr`)
10398

@@ -147,7 +142,6 @@ Problem expected closure date
147142
[Milestone when the problem should be resolved]
148143

149144
If possible, use for problem closure date the properties of the selected Issue Tracking System
150-
(Update here with example from GitHub, after this PR is merged)
151145

152146
(to be filled out during :need:`wf__problem__create_pr`)
153147

process/process_areas/problem_resolution/problem_resolution_concept.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,24 @@ Stakeholders for the Problem Report
4444

4545
#. :need:`Contributor <rl__contributor>`
4646

47-
* Contributes features and components to grow the project content
47+
* In general contributes features and components to grow the project content
48+
* Reports problems, analyze problems, implement problem resolutions
4849

4950
#. :need:`Committer <rl__committer>`
5051

51-
* Verifies that the contribution fulfills the project policies
52-
* Approves the contribution
52+
* Verifies that the contribution including problem resolutions fulfills the project policies
53+
* Approves all problem resolution activities besides problem closing
54+
* Is responsible to initiate the the closure of the problem reported
55+
56+
#. :need:`Technical Lead <rl__technical_lead>`, :need:`Module Lead <rl__module_lead>`
57+
58+
* Supports all problem resolution activities
59+
* Approves the closing of the problem resolution
60+
61+
#. :need:`Safety Manager <rl__safety_manager>`, :need:`Security Manager <rl__security_manager>`, :need:`Quality Manager <rl__quality_manager>`
62+
63+
* Supports all problem resolution activities
64+
5365

5466
Standard Requirements
5567
=====================
@@ -58,15 +70,7 @@ Also requirements of standards need to be taken into consideration:
5870

5971
* ISO 26262
6072
* ASPICE
61-
* ISO SAE 21434
62-
63-
Problem Report Categories
64-
*************************
65-
66-
User: Problems relating to requirements, architecture, implementation, or code found by user of the platform.
67-
68-
Bug: Problems found by contributor based on component, feature or platform integration tests including verification and quality assurance activities.
69-
73+
* ISO/SAE 21434
7074

7175
.. _prm_attributes:
7276

0 commit comments

Comments
 (0)