Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 94 additions & 0 deletions .github/ISSUE_TEMPLATE/3-change.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# *******************************************************************************
# Copyright (c) 2025 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

name: "Change Request"
description: Issue to track a change
title: "Change: Your Change Request title"
labels: ["codeowner_review"]
body:
- type: dropdown
attributes:
label: Change Request Type
Copy link
Contributor

@aschemmel-tech aschemmel-tech Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we discussed the change request of @odra (eclipse-score/score#1740) - the question was risen if there may be also "other" change requests - because this one is not really fitting in those categories (it is more about updating the process). But maybe we were wrong to say this should be a Change Request as it should be a "Improvement"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would agree, Process updates should be taken as Improvement

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep improvement template (for processes) seperate and link to it here in Change Mgt process.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add the link as comment

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

select field should not contain the link in the selection text. I would have expected this even in the guideline instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed, does not show up any more, add as comment in the description part and some comment in the guideline

options:
- Feature Request
- Feature Modification
- Component Request
- Component Modification
default: 0
validations:
required: true
- type: textarea
attributes:
label: Description of the Change Request
description: |
- Exact description of the Change Request
- Impact to users of the feature/component
- Use following template within a PR and link it to this issue
[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
[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
[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
validations:
required: true
- type: textarea
attributes:
label: Estimates for realization
description: |
- Estimate the effort, resources, risk for the realization
validations:
required: true
- type: checkboxes
attributes:
label: Affects work products
options:
- label: Requirements
- label: Architecture
- label: Safety/Security Analysis
- label: Detailed Design
required: true
- type: textarea
attributes:
label: Impact analysis
description: |
- Details on the impacted work products
- Use the following template and/or run the impact analysis tool provided
If the following template is use within a PR, link it to this issue
[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
validations:
required: true
- type: checkboxes
attributes:
label: Safety or Security relevance
options:
- label: none
- label: Safety relevant
- label: Security relevant
validations:
required: true
- type: dropdown
attributes:
label: ASIL classification
options:
- QM
- ASIL_B
default: 0
validations:
required: true
- type: dropdown
attributes:
label: Expected Implementation Version
options:
- 0.5
- 1.0
default: 0
validations:
required: false
2 changes: 1 addition & 1 deletion process/general_concepts/score_lifecycle_concept.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Contributions to the project are driven by feature/component requests.

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

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

Expand Down
152 changes: 48 additions & 104 deletions process/process_areas/change_management/change_management_concept.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,17 @@ including the requirements of the different stakeholders for the Change Manageme

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

Inputs
******

#. Stakeholders for the Change Requests?
#. Which Change Requests types can we derive from that?
#. Which attributes are required?
#. Which activities are required?

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

#. :need:`Contributor <rl__contributor>`

* Contributes features and components to grow the **S-CORE** content

Contribution include scope modification of existing features/components or adding new
features/components.
* In general contributes features and components to grow the project content
* Creates change requests, analyzes changes, implement changes

#. :need:`Committer <rl__committer>`

* Verifies that the contribution fulfills the **S-CORE** policies
* Approves the contribution
* Verifies that the contribution including change requests fulfills the project policies
* Approves all change request activities besides changes closing
* Is responsible to initiate the the closure of the change request

#. :need:`Technical Lead <rl__technical_lead>`, :need:`Module Lead <rl__module_lead>`

* Supports all change request activities
* Approves the closing of the change request

#. :need:`Safety Manager <rl__safety_manager>`, :need:`Security Manager <rl__security_manager>`, :need:`Quality Manager <rl__quality_manager>`

* Supports all change request activities

Standard Requirements
=====================
Expand All @@ -65,89 +72,33 @@ Also requirements of standards need to be taken into consideration:
* ASPICE
* ISO SAE 21434

Change Request Types
********************

Feature
=======

This Change Request describes a potential new feature for the platform.
The Change Request uses the Feature request template: :ref:`chm_feature_templates`.

Feature Modification
====================

This Change Request describes a scope modification of an existing feature (requirement or work
product). The Change Request modifies the already existing Feature Request template: :ref:`chm_feature_templates`.

Component
=========

This Change Request describes a potential new component for the platform.
The Change Request uses the Component request template: :ref:`chm_component_templates`.

Component Modification
======================

This Change Request describes a scope modification of an existing component (requirement or work
product). The Change Request modifies the already existing Component Request template: :ref:`chm_component_templates`.


.. _chm_attributes:

Attributes of Change Requests
*****************************

The required attributes for the Change Requests are defined in this subchapter.

Following attributes need to be filled manually for each Change Request:

.. list-table:: Manual Attributes
:header-rows: 1
:widths: 15,85

* - Attribute
- Description
* - Unique ID
- The unique id
* - Status
- The status of a Change Request can either be "draft", "in review", "accepted" or "rejected".
* - Title
- Reason for the Change Request
* - Description
- Exact description of the Change Request
* - Safety
- These attribute describes the impact on functional safety.
* - Security
- This attribute describes the impact on security
* - Change Request Type
- Following types are defined: [Feature, Feature Modification, Component, Component Modification]
* - Affected work products
- Links to the work products affected by the Change Request
* - Milestone
- Planned date (milestone) of deployment of the Change Request
The required attributes for the Change Request are defined here: :ref:`chm_process_change_request_attributes`.


Activities for a Change Request
*******************************

.. _chm_analysis:
.. _chm_creation:

Analysis of the Change Request
Creation of the Change Request
==============================
Use the content :ref:`Feature Request Template <chm_feature_templates>` or
:ref:`Component Request Template <chm_component_templates>` to create a Change Request.

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

.. _chm_evaluation:

Evaluation of the Change Request
================================
.. _chm_analysis:

Based on the analysis results decision about the acceptance, rejection or delay must be taken
Analysis of the Change Request
==============================
Based on the analysis results decision about the acceptance or rejection must be taken
by authorized persons.

Authorized person includes
Expand All @@ -160,38 +111,31 @@ Authorized person includes

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

.. _chm_implementation_monitoring:

.. _chm_implementation:

Implementation of the Change Request
====================================
If the Change Request is accepted, it must be implemented.
Implementation and Monitoring of the Change Request
===================================================
If the Change Request is accepted, the implementation of the change must be initiated and
monitored.


.. _chm_verification:

Verification of the Change Request
==================================

The defined verification measures must be use to confirm the implementation.


.. _chm_reporting:

Reporting of the Change Request
===============================
The Change Request implementation must be tracked until it is closed.

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

.. _chm_closing:

Closing of the Change Request
=============================

.. _chm_traceability:
Use the :ref:`Change Request Review Checklist <chm_checklist>` to control the completeness of the
Change Request to be closed.

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

The standards require that a Change Request can be traced throughout the complete hierarchy levels
including all affected work products.
The standards require that a Change Request can be traced throughout the complete
hierarchy levels including all affected work products.

In general the traceability is visualized in the general traceability concept (:ref:`general_concepts_traceability`).
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,31 @@ Getting Started
:status: valid
:tags: change_management

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

* Contact the :need:`Technical Lead <rl__technical_lead>` for your contribution to establish planning and reporting
* Create your change requests according to :need:`wf__change_cr_an_change_request`
* Make familiar with the development and supporting process descriptions in :ref:`process_description`
* 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>`
Examples for change requests:

* New feature e.g. communication, debugging, health management, cryptography introduced (feature request).
* Existing feature, e.g. communication supports new protocol (feature modification).
* New component for parsing a protocol introduced (component request).
* API change for an existing component (component modification).

Therefore guidelines :need:`gd_temp__change_feature_request` and
:need:`gd_temp__change_component_request`, :need:`gd_guidl__change_change_request` and
a :need:`doc_concept__change_process` are available.

General Workflow
****************

The workflows are defined in the :ref:`chm_change_workflows` section.

For every change identified, the following workflows are executed:

* Create your change request according to :need:`wf__change_create_cr`
* Analyze change request report according to :need:`wf__change_analyze_cr`
* Implement change request and monitor it until closure according to :need:`wf__change_implement_monitor_cr`
* Close the change request according to :need:`wf__change_close_cr`

In addition create a change management plan as part of the platform management plan according to :need:`wf__platform_cr_mt_platform_mgmt_plan`
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Contributing Roles:

* :need:`Contributor <rl__contributor>`
* :need:`Committer <rl__committer>`
* :need:`Contributor <rl__technical_lead>`
* :need:`Technical Project Lead <rl__technical_lead>`
* :need:`Module Project Lead <rl__module_lead>`
* :need:`Safety Manager <rl__safety_manager>`
* :need:`Security Manager <rl__security_manager>`
Expand Down
Loading