Skip to content

Commit 72c95d7

Browse files
committed
update problem resolution
adressed audit findings, Action_13, Action_14 introduce issue templates to be used for creating bug issues and examples Resolves: #86
1 parent cc48423 commit 72c95d7

File tree

11 files changed

+246
-90
lines changed

11 files changed

+246
-90
lines changed
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# *******************************************************************************
2+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
3+
#
4+
# See the NOTICE file(s) distributed with this work for additional
5+
# information regarding copyright ownership.
6+
#
7+
# This program and the accompanying materials are made available under the
8+
# terms of the Apache License Version 2.0 which is available at
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# SPDX-License-Identifier: Apache-2.0
12+
# *******************************************************************************
13+
14+
name: Problem Report
15+
description: Issue to track a bug
16+
title: "Bug: Your bugfix title"
17+
labels: ["codeowner_review"]
18+
body:
19+
- type: markdown
20+
attributes:
21+
value: "## <ins>Bug Ticket creation</ins>"
22+
- type: textarea
23+
attributes:
24+
label: Description
25+
description: Short Description of the Bug
26+
validations:
27+
required: true
28+
- type: dropdown
29+
attributes:
30+
label: Error Occurrence Rate
31+
options:
32+
- Single Event
33+
- Sporadic
34+
- Highly Intermittent
35+
- Reproducible
36+
- type: textarea
37+
attributes:
38+
label: How to reproduce
39+
description: How to reproduce?
40+
- type: textarea
41+
attributes:
42+
label: Supporting Information
43+
description: |
44+
During which operational state did the issue occur
45+
Observations / Screenshots / Traces
46+
validations:
47+
required: false
48+
- type: dropdown
49+
attributes:
50+
label: Classification
51+
options:
52+
- minor
53+
- major
54+
- critical
55+
- blocker
56+
default: 0
57+
validations:
58+
required: true
59+
- type: dropdown
60+
attributes:
61+
label: Affected Version
62+
options:
63+
- 0.5
64+
- 1.0
65+
default: 0
66+
validations:
67+
required: true
68+
- type: dropdown
69+
attributes:
70+
label: Expected Closure Version
71+
options:
72+
- 0.5
73+
- 1.0
74+
default: 0
75+
validations:
76+
required: false
77+
- type: checkboxes
78+
attributes:
79+
label: Category
80+
options:
81+
- label: Safety Related
82+
- label: Security Related
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# *******************************************************************************
2+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
3+
#
4+
# See the NOTICE file(s) distributed with this work for additional
5+
# information regarding copyright ownership.
6+
#
7+
# This program and the accompanying materials are made available under the
8+
# terms of the Apache License Version 2.0 which is available at
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# SPDX-License-Identifier: Apache-2.0
12+
# *******************************************************************************
13+
14+
name: "Improvement / Task"
15+
description: Issue to track a improvement / task
16+
title: "Improvement: Your Improvement title"
17+
labels: ["codeowner_review"]
18+
body:
19+
- type: textarea
20+
attributes:
21+
label: What
22+
description: |
23+
- Goal of the Improvement / Task
24+
- If Req/Architecture is affected, the template of
25+
[Change Management](https://eclipse-score.github.io/process_description/main/process_areas/change_management/guidance/change_management_impact_analysis_template.html) needs to be used
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: How
31+
description: Details on implementation approach
32+
validations:
33+
required: false
34+
- type: textarea
35+
attributes:
36+
label: Estimates for realization
37+
description: |
38+
- Estimate the effort, resources, risk for the realization
39+
- Impact to users of the feature
40+
validations:
41+
required: true
42+
- type: checkboxes
43+
attributes:
44+
label: Category
45+
options:
46+
- label: Affects Detailed Design
47+
- type: checkboxes
48+
attributes:
49+
label: Requirements / Architecture
50+
options:
51+
- label: Requirements / Architecture are not affected by this change?
52+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# *******************************************************************************
2+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
3+
#
4+
# See the NOTICE file(s) distributed with this work for additional
5+
# information regarding copyright ownership.
6+
#
7+
# This program and the accompanying materials are made available under the
8+
# terms of the Apache License Version 2.0 which is available at
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# SPDX-License-Identifier: Apache-2.0
12+
# *******************************************************************************
13+
14+
blank_issues_enabled: false

process/process_areas/platform_management/platform_management_workflow.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Workflow Platform Management
2525
:approved_by: rl__process_community
2626
:supported_by: rl__safety_manager, rl__security_manager, rl__quality_manager
2727
:input: wp__policies, wp__issue_track_system
28-
:output: wp__platform_mgmt, wp__project_mgt, wp__document_mgt_plan, wp__config_mgt_plan
28+
:output: wp__platform_mgmt, wp__project_mgt, wp__document_mgt_plan, wp__config_mgt_plan, wp__prm_plan
2929
:contains: gd_temp__platform__mgmt_plan, gd_guidl__platform__mgmt_plan, gd_guidl__documentation, gd_chklst__documentation__review, gd_temp__documentation
3030
:has: doc_concept__platform__process, doc_getstrt__platform__process
3131

process/process_areas/problem_resolution/guidance/problem_resolution_checklist.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,5 +86,5 @@ Problem Checklist
8686
-
8787

8888
* - 13
89-
- If the Problem report is not closed and pending solution measures are open, escalated to the :need:`rl__safety_manager`?
89+
- If the Problem report is not closed and pending solution measures are open, escalated to the :need:`rl__safety_manager` or :need:`rl__security_manager`?
9090
-

process/process_areas/problem_resolution/guidance/problem_resolution_guideline.rst

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,13 @@ This document describes the general guidances for Problem Resolution based on th
2525
General Hints
2626
=============
2727

28-
The detailed implementation of the Problem Resolution for **S-CORE** is described in the `[[title]]<REPLACE_doc__platform_problem_resolution_plan>`.
28+
The detailed implementation of the Problem Resolution for the project shall be described in the :ref:`Workflow Platform Management <workflow_platform_management>`.
2929

3030
Templates
3131
---------
3232

33-
To create problem reports, **S-CORE** provides the following template: :need:`[[title]]<gd_temp__problem__template>`.
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)
3435

3536
Attributes
3637
----------
@@ -52,31 +53,32 @@ A more detailed description can be found here: :ref:`prm_process_requirements`
5253
Activities for Problem Resolution
5354
=================================
5455

55-
This section describes in detail which steps need to be performed for a Problem resolution.
56-
57-
Refer to the `Problem Resolution Plan <REPLACE_doc__platform_problem_resolution_plan>` for examples
58-
how to create problem reports.
56+
This section describes in detail which steps need to be performed for a Problem Resolution.
5957

6058
.. list-table:: Activities for Problem Resolution
6159
:header-rows: 1
62-
:widths: 10,60,30
60+
:widths: 10,60,30,30
6361

6462
* - Step
6563
- Description
6664
- Responsible
65+
- Approver
6766
* - :ref:`1. <prm_create_problem_report>`
6867
- Create Problem Report
6968
- :need:`[[title]] <rl__contributor>`
69+
- :need:`[[title]] <rl__committer>`
7070
* - :ref:`2. <prm_analyze_problem_report>`
71-
- Analyse Problem Report
71+
- Analyze Problem Report
7272
- :need:`[[title]] <rl__contributor>`
73+
- :need:`[[title]] <rl__committer>`
7374
* - :ref:`3. <prm_initiate_problem_resolution>`
7475
- Initiate and Monitor Problem Resolution
7576
- :need:`[[title]] <rl__contributor>`
77+
- :need:`[[title]] <rl__committer>`
7678
* - :ref:`4. <prm_monitor_problem_resolution>`
7779
- Close Problem Resolution
7880
- :need:`[[title]] <rl__committer>`
79-
81+
- :need:`[[title]] <rl__technical_lead>`, :need:`[[title]] <rl__module_lead>`
8082

8183
.. _prm_create_problem_report:
8284

@@ -94,18 +96,18 @@ The description should reflect the problem root cause and impact in detail.
9496
Copy therefore the :need:`Problem Template <gd_temp__problem__template>` into the created Problem
9597
Report (Issue Tracking System).
9698

97-
Set the status of the Problem to "open", when ready to review and analyse set to "in review".
99+
Set the status of the Problem to "open", when ready to review and analyze set to "in review".
98100

99101
.. _prm_analyze_problem_report:
100102

101-
Analyse Problem Report
103+
Analyze Problem Report
102104
----------------------
103105

104-
The **S-CORE** :need:`[[title]] <rl__committer>` analyzes the problem together with the
106+
The projects :need:`[[title]] <rl__committer>` analyzes the problem together with the
105107
:need:`[[title]] <rl__contributor>` and takes a decision for accepting or rejecting it.
106108

107109
If accepted, the status is set to "in implementation" and :need:`[[title]] <rl__contributor>`
108-
can start with the iniation of the Problem Resolution, otherwise the status is set to "rejected".
110+
can start with the initiation of the Problem Resolution, otherwise the status is set to "rejected".
109111

110112
The author has the freedom to cancel it at any time by setting the status to "rejected".
111113

@@ -119,7 +121,7 @@ Initiate and Monitor Problem Resolution
119121
Therefore further activities needs to be planned and linked to the Problem Report.
120122

121123
During the resolution the responsible lead :need:`[[title]] <rl__technical_lead>` or
122-
:need:`[[title]] <rl__module_lead>` reports regularly the status to the affected **S-CORE** teams.
124+
:need:`[[title]] <rl__module_lead>` reports regularly the status to the affected projects teams.
123125

124126
The author has the freedom to cancel it at any time by setting the status to "rejected".
125127

process/process_areas/problem_resolution/guidance/problem_resolution_reqs.rst

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Problem Attributes
2626
:id: gd_req__problem__attr_uid
2727
:status: valid
2828
:tags: done_automation, problem_resolution, attribute, mandatory
29-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
29+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
3030
:complies: std_req__aspice_40__SUP-9-BP1
3131

3232
Each Problem shall have a unique ID. It shall be in an integer number.
@@ -35,7 +35,7 @@ Problem Attributes
3535
:id: gd_req__problem__attr_status
3636
:status: valid
3737
:tags: manual, problem_resolution, attribute, mandatory
38-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
38+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
3939
:complies: std_req__aspice_40__SUP-9-BP1
4040

4141
Each Problem shall have a status:
@@ -50,7 +50,7 @@ Problem Attributes
5050
:id: gd_req__problem__attr_title
5151
:status: valid
5252
:tags: manual, problem_resolution, attribute, mandatory
53-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
53+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
5454
:complies: std_req__aspice_40__SUP-9-BP1
5555

5656
Reason for Problem Report
@@ -59,21 +59,21 @@ Problem Attributes
5959
:id: gd_req__problem__attr_impact_description
6060
:status: valid
6161
:tags: manual, problem_resolution, attribute, mandatory
62-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
62+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
6363
:complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP2
6464

6565
Exact description of the Problem, including potential cause and impact of the problem.
6666

6767
Record especially, if functional safety or cybersecurity may affected here.
6868

69-
Record potential affected parties, and if it may requried to notify them about the potential
69+
Record potential affected parties, and if it may required to notify them about the potential
7070
problem.
7171

7272
.. gd_req:: Problem attribute: analysis results
7373
:id: gd_req__problem__attr_anaylsis_results
7474
:status: valid
7575
:tags: manual, problem_resolution, attribute, mandatory
76-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
76+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
7777
:complies: std_req__aspice_40__SUP-9-BP2
7878

7979
Record analysis results (e.g. reason for rejection, safety, security, quality impact) as comments.
@@ -82,17 +82,17 @@ Problem Attributes
8282
:id: gd_req__problem__attr_stakeholder
8383
:status: valid
8484
:tags: prio_1_automation, problem_resolution, attribute, mandatory
85-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
85+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
8686
:complies: std_req__aspice_40__SUP-9-BP2, std_req__aspice_40__SUP-9-BP5
8787

88-
Assign responsible stakeholder for analysing the problem
88+
Assign responsible stakeholder for analyzing the problem
8989
Assign responsible stakeholder to resolve the problem
9090

9191
.. gd_req:: Problem attribute: classification
9292
:id: gd_req__problem__attr_classification
9393
:status: valid
9494
:tags: prio_1_automation, problem_resolution, attribute, mandatory
95-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
95+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
9696
:complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP2
9797

9898
Each Problem shall have a classification identifier:
@@ -102,23 +102,11 @@ Problem Attributes
102102
* critical
103103
* blocker
104104

105-
.. gd_req:: Problem attribute: category
106-
:id: gd_req__problem__attr_category
107-
:status: valid
108-
:tags: prio_3_automation, problem_resolution, attribute, mandatory
109-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
110-
:complies: std_req__aspice_40__SUP-9-BP1
111-
112-
Each Problem shall have a category identifier:
113-
114-
* User
115-
* Bug
116-
117105
.. gd_req:: Problem attribute:: safety affected
118106
:id: gd_req__problem__attr_safety_affected
119107
:status: valid
120108
:tags: prio_1_automation, problem_resolution, attribute, mandatory
121-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
109+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
122110
:complies: std_req__aspice_40__SUP-9-BP1
123111

124112
Each Problem shall have a safety relevance identifier:
@@ -132,7 +120,7 @@ Problem Attributes
132120
:id: gd_req__problem__attr_security_affected
133121
:status: valid
134122
:tags: prio_1_automation, problem_resolution, attribute, mandatory
135-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
123+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
136124
:complies: std_req__aspice_40__SUP-9-BP1
137125

138126
Each Problem shall have a security relevance identifier:
@@ -146,7 +134,7 @@ Problem Attributes
146134
:id: gd_req__problem__attr_milestone
147135
:status: valid
148136
:tags: manual, problem_resolution, attribute, mandatory
149-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
137+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
150138
:complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP6
151139

152140
Milestone until the Problem must be implemented (used for prioritization)
@@ -159,7 +147,7 @@ Problem Resolution Checks
159147
:id: gd_req__problem__check_mandatory
160148
:status: valid
161149
:tags: prio_2_automation, problem_resolution, attribute, check
162-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
150+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
163151
:complies: std_req__aspice_40__SUP-9-BP1
164152

165153
It shall be checked if all mandatory attributes for each Problem
@@ -175,7 +163,7 @@ Problem Resolution Checks
175163
:id: gd_req__problem__check_closing
176164
:status: valid
177165
:tags: prio_1_automation, problem_resolution, attribute, check
178-
:satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
166+
:satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
179167
:complies: std_req__aspice_40__SUP-9-BP1
180168

181169
ISSUEs related to Problem Reports shall not automatically closed, if linked ISSUEs or PRs are closed or merged and

0 commit comments

Comments
 (0)