Skip to content

Commit 6e7f310

Browse files
committed
update change management
Fix audit findings, Align with Problem Resolution Define issue template for change request Remove links to score repo Resolves: #53
1 parent 9aee3a6 commit 6e7f310

File tree

10 files changed

+461
-243
lines changed

10 files changed

+461
-243
lines changed
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
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: "Change Request"
15+
description: Issue to track a change
16+
title: "Change: Your Change Request title"
17+
labels: ["codeowner_review"]
18+
body:
19+
- type: dropdown
20+
attributes:
21+
label: Change Request Type
22+
options:
23+
- Feature Request
24+
- Feature Modification
25+
- Component Request
26+
- Component Modification
27+
default: 0
28+
validations:
29+
required: true
30+
- type: textarea
31+
attributes:
32+
label: Description of the Change Request
33+
description: |
34+
- Exact description of the Change Request
35+
- Impact to users of the feature/component
36+
- Use following template within a PR and link it to this issue
37+
[Change Management Feature Request Template](https://eclipse-score.github.io/process_description/main/process_areas/change_management/guidance/change_management_feature_template.html) needs to be used
38+
[Change Management Component Request Template](https://eclipse-score.github.io/process_description/main/process_areas/change_management/guidance/change_management_component_template.html) needs to be used
39+
[For (Process) Improvements, Improvement Issue Template](https://github.com/eclipse-score/process_description/blob/main/.github/ISSUE_TEMPLATE/2-improvement.yml) needs to be used
40+
validations:
41+
required: true
42+
- type: textarea
43+
attributes:
44+
label: Estimates for realization
45+
description: |
46+
- Estimate the effort, resources, risk for the realization
47+
validations:
48+
required: true
49+
- type: checkboxes
50+
attributes:
51+
label: Affects work products
52+
options:
53+
- label: Requirements
54+
- label: Architecture
55+
- label: Safety/Security Analysis
56+
- label: Detailed Design
57+
required: true
58+
- type: textarea
59+
attributes:
60+
label: Impact analysis
61+
description: |
62+
- Details on the impacted work products
63+
- Use the following template and/or run the impact analysis tool provided
64+
If the following template is use within a PR, link it to this issue
65+
[Change Management Impact Analysis Template](https://eclipse-score.github.io/process_description/main/process_areas/change_management/guidance/change_management_impact_analysis_template.html) needs to be used
66+
validations:
67+
required: true
68+
- type: checkboxes
69+
attributes:
70+
label: Safety or Security relevance
71+
options:
72+
- label: none
73+
- label: Safety relevant
74+
- label: Security relevant
75+
validations:
76+
required: true
77+
- type: dropdown
78+
attributes:
79+
label: ASIL classification
80+
options:
81+
- QM
82+
- ASIL_B
83+
default: 0
84+
validations:
85+
required: true
86+
- type: dropdown
87+
attributes:
88+
label: Expected Implementation Version
89+
options:
90+
- 0.5
91+
- 1.0
92+
default: 0
93+
validations:
94+
required: false

process/general_concepts/score_lifecycle_concept.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Contributions to the project are driven by feature/component requests.
2121

2222
As features and components are the main structuring elements of the project, new
2323
features and components are requested by feature or components requests (compare
24-
:need:`wf__change_cr_an_change_request`). Both are special types of change requests.
24+
:need:`wf__change_create_cr`). Both are special types of change requests.
2525

2626
The figure below shows the standard lifecycle of any feature/component in the project.
2727

process/process_areas/change_management/change_management_concept.rst

Lines changed: 48 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,17 @@ including the requirements of the different stakeholders for the Change Manageme
2626

2727
Key concept
2828
***********
29-
A Change Request is the **ONLY** way to contribute (compare `REPLACE_doc__contr_guideline`)
30-
new features or to modify the scope of existing features in the **S-CORE** project.
31-
As features are built-up by Components a Change Request is also needed to add new Components or
32-
to modify the scope of existing Components.
33-
As a Software Module is defined as the top-level Component, all statements here for Components
34-
are also valid for Software Modules.
29+
A Change Request is the **ONLY** way to contribute new features or to modify the scope
30+
of existing features in the project.
31+
As features are built-up by Components a Change Request is also needed to add new
32+
Components or to modify the scope of existing Components.
33+
As a Software Module is defined as the top-level Component, all statements here for
34+
Components are also valid for Software Modules.
3535

3636
Inputs
3737
******
3838

3939
#. Stakeholders for the Change Requests?
40-
#. Which Change Requests types can we derive from that?
4140
#. Which attributes are required?
4241
#. Which activities are required?
4342

@@ -46,15 +45,23 @@ Stakeholders for the Change Requests
4645

4746
#. :need:`Contributor <rl__contributor>`
4847

49-
* Contributes features and components to grow the **S-CORE** content
50-
51-
Contribution include scope modification of existing features/components or adding new
52-
features/components.
48+
* In general contributes features and components to grow the project content
49+
* Creates change requests, analyzes changes, implement changes
5350

5451
#. :need:`Committer <rl__committer>`
5552

56-
* Verifies that the contribution fulfills the **S-CORE** policies
57-
* Approves the contribution
53+
* Verifies that the contribution including change requests fulfills the project policies
54+
* Approves all change request activities besides changes closing
55+
* Is responsible to initiate the the closure of the change request
56+
57+
#. :need:`Technical Lead <rl__technical_lead>`, :need:`Module Lead <rl__module_lead>`
58+
59+
* Supports all change request activities
60+
* Approves the closing of the change request
61+
62+
#. :need:`Safety Manager <rl__safety_manager>`, :need:`Security Manager <rl__security_manager>`, :need:`Quality Manager <rl__quality_manager>`
63+
64+
* Supports all change request activities
5865

5966
Standard Requirements
6067
=====================
@@ -65,89 +72,33 @@ Also requirements of standards need to be taken into consideration:
6572
* ASPICE
6673
* ISO SAE 21434
6774

68-
Change Request Types
69-
********************
70-
71-
Feature
72-
=======
73-
74-
This Change Request describes a potential new feature for the platform.
75-
The Change Request uses the Feature request template: :ref:`chm_feature_templates`.
76-
77-
Feature Modification
78-
====================
79-
80-
This Change Request describes a scope modification of an existing feature (requirement or work
81-
product). The Change Request modifies the already existing Feature Request template: :ref:`chm_feature_templates`.
82-
83-
Component
84-
=========
85-
86-
This Change Request describes a potential new component for the platform.
87-
The Change Request uses the Component request template: :ref:`chm_component_templates`.
88-
89-
Component Modification
90-
======================
91-
92-
This Change Request describes a scope modification of an existing component (requirement or work
93-
product). The Change Request modifies the already existing Component Request template: :ref:`chm_component_templates`.
94-
95-
9675
.. _chm_attributes:
9776

9877
Attributes of Change Requests
9978
*****************************
10079

101-
The required attributes for the Change Requests are defined in this subchapter.
102-
103-
Following attributes need to be filled manually for each Change Request:
104-
105-
.. list-table:: Manual Attributes
106-
:header-rows: 1
107-
:widths: 15,85
108-
109-
* - Attribute
110-
- Description
111-
* - Unique ID
112-
- The unique id
113-
* - Status
114-
- The status of a Change Request can either be "draft", "in review", "accepted" or "rejected".
115-
* - Title
116-
- Reason for the Change Request
117-
* - Description
118-
- Exact description of the Change Request
119-
* - Safety
120-
- These attribute describes the impact on functional safety.
121-
* - Security
122-
- This attribute describes the impact on security
123-
* - Change Request Type
124-
- Following types are defined: [Feature, Feature Modification, Component, Component Modification]
125-
* - Affected work products
126-
- Links to the work products affected by the Change Request
127-
* - Milestone
128-
- Planned date (milestone) of deployment of the Change Request
80+
The required attributes for the Change Request are defined here: :ref:`chm_process_change_request_attributes`.
12981

13082

13183
Activities for a Change Request
13284
*******************************
13385

134-
.. _chm_analysis:
86+
.. _chm_creation:
13587

136-
Analysis of the Change Request
88+
Creation of the Change Request
13789
==============================
90+
Use the content :ref:`Feature Request Template <chm_feature_templates>` or
91+
:ref:`Component Request Template <chm_component_templates>` to create a Change Request.
13892

139-
The affected work products must be identified.
140-
The potential impact on functional safety and security must be addressed.
141-
Schedule, risks, resources for the realization must be evaluated.
142-
Verification measures must be defined.
143-
Use therefore the : :ref:`Impact Analysis Template <chm_impact_analysis_templates>`.
93+
In case safety or security is affected, in addition the impact analysis template
94+
: :ref:`Impact Analysis Template <chm_impact_analysis_templates>` can be used to detail
95+
out the impact on safety/security.
14496

145-
.. _chm_evaluation:
146-
147-
Evaluation of the Change Request
148-
================================
97+
.. _chm_analysis:
14998

150-
Based on the analysis results decision about the acceptance, rejection or delay must be taken
99+
Analysis of the Change Request
100+
==============================
101+
Based on the analysis results decision about the acceptance or rejection must be taken
151102
by authorized persons.
152103

153104
Authorized person includes
@@ -160,38 +111,31 @@ Authorized person includes
160111

161112
Further prioritization must be done, e.g. based on release planning.
162113

114+
.. _chm_implementation_monitoring:
163115

164-
.. _chm_implementation:
165-
166-
Implementation of the Change Request
167-
====================================
168-
If the Change Request is accepted, it must be implemented.
116+
Implementation and Monitoring of the Change Request
117+
===================================================
118+
If the Change Request is accepted, the implementation of the change must be initiated and
119+
monitored.
169120

170-
171-
.. _chm_verification:
172-
173-
Verification of the Change Request
174-
==================================
175-
176-
The defined verification measures must be use to confirm the implementation.
177-
178-
179-
.. _chm_reporting:
180-
181-
Reporting of the Change Request
182-
===============================
121+
The Change Request implementation must be tracked until it is closed.
183122

184123
The status of the Change Request must be communicated by the
185124
:need:`Technical Lead <rl__technical_lead>` or :need:`Module Lead <rl__module_lead>` until
186125
the implementation is completed and confirmed.
187126

127+
.. _chm_closing:
128+
129+
Closing of the Change Request
130+
=============================
188131

189-
.. _chm_traceability:
132+
Use the :ref:`Change Request Review Checklist <chm_checklist>` to control the completeness of the
133+
Change Request to be closed.
190134

191-
Traceability Concept for Change Requests
192-
========================================
135+
Especially the effectiveness of the solution measures must be shown, based on convincing
136+
arguments, e.g. verification measures must be used to confirm the implementation.
193137

194-
The standards require that a Change Request can be traced throughout the complete hierarchy levels
195-
including all affected work products.
138+
The standards require that a Change Request can be traced throughout the complete
139+
hierarchy levels including all affected work products.
196140

197141
In general the traceability is visualized in the general traceability concept (:ref:`general_concepts_traceability`).

process/process_areas/change_management/change_management_getstrt.rst

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,31 @@ Getting Started
2020
:status: valid
2121
:tags: change_management
2222

23-
In case you want to contribute a change to **S-CORE** consider to:
23+
This document describes the steps to create a change request, and further to analyze,
24+
implement, and to control the change until closure. Where a change is defined as an
25+
introduction of a new feature/component or modification of an existing feature/component.
2426

25-
* Contact the :need:`Technical Lead <rl__technical_lead>` for your contribution to establish planning and reporting
26-
* Create your change requests according to :need:`wf__change_cr_an_change_request`
27-
* Make familiar with the development and supporting process descriptions in :ref:`process_description`
28-
* Make familiar with the relevant sections of the `Platform Management Plan <REPLACE_doc__platform_mgt_plan>`, here especially with `Change Management Plan <REPLACE_doc__platform_change_management_plan>`
27+
Examples for change requests:
28+
29+
* New feature e.g. communication, debugging, health management, cryptography introduced (feature request).
30+
* Existing feature, e.g. communication supports new protocol (feature modification).
31+
* New component for parsing a protocol introduced (component request).
32+
* API change for an existing component (component modification).
33+
34+
Therefore guidelines :need:`gd_temp__change_feature_request` and
35+
:need:`gd_temp__change_component_request`, :need:`gd_guidl__change_change_request` and
36+
a :need:`doc_concept__change_process` are available.
37+
38+
General Workflow
39+
****************
40+
41+
The workflows are defined in the :ref:`chm_change_workflows` section.
42+
43+
For every change identified, the following workflows are executed:
44+
45+
* Create your change request according to :need:`wf__change_create_cr`
46+
* Analyze change request report according to :need:`wf__change_analyze_cr`
47+
* Implement change request and monitor it until closure according to :need:`wf__change_implement_monitor_cr`
48+
* Close the change request according to :need:`wf__change_close_cr`
49+
50+
In addition create a change management plan as part of the platform management plan according to :need:`wf__platform_cr_mt_platform_mgmt_plan`

process/process_areas/change_management/change_management_roles.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Contributing Roles:
2121

2222
* :need:`Contributor <rl__contributor>`
2323
* :need:`Committer <rl__committer>`
24-
* :need:`Contributor <rl__technical_lead>`
24+
* :need:`Technical Project Lead <rl__technical_lead>`
2525
* :need:`Module Project Lead <rl__module_lead>`
2626
* :need:`Safety Manager <rl__safety_manager>`
2727
* :need:`Security Manager <rl__security_manager>`

0 commit comments

Comments
 (0)