Skip to content

update of change management to consider new FEP proposal#748

Open
masc2023 wants to merge 7 commits into
mainfrom
update_change_management
Open

update of change management to consider new FEP proposal#748
masc2023 wants to merge 7 commits into
mainfrom
update_change_management

Conversation

@masc2023

Copy link
Copy Markdown
Contributor

As proposed the Change Management process is updated to reflect the FEP.

Resolves partly: eclipse-score/score#3085

Comment thread process/folder_templates/platform/features/feature_name/index.rst
@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@masc2023 masc2023 requested a review from qor-lb July 15, 2026 07:14

@qor-lb qor-lb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Definitely goes into the right direction, thanks! some minor changes below.

Comment thread process/folder_templates/platform/docs/change/decision_record.rst Outdated
Comment thread process/folder_templates/platform/features/feature_name/index.rst Outdated
Comment thread process/folder_templates/platform/features/feature_name/index.rst Outdated
Comment thread process/folder_templates/platform/features/feature_name/index.rst Outdated
Comment thread process/folder_templates/platform/features/feature_name/index.rst Outdated
Comment thread process/folder_templates/platform/features/feature_name/index.rst
Comment on lines +99 to +100
Use the content :ref:`Decision Record Template <decision_record_template>` to create a
Change Request.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not every change should/must end up in a decision record. I tried to also document this in the CMP in score. The DR/FEP path should be only for "bigger"/"major" changes - because this path also takes a lot more time to find agreement. We should still have a shorter path for smaller changes that don't need that level of alignment.

Can we somehow separate the information that has to be available in a change request from the format? That way we could then define in the CMP in score that major changes persist this information in a DR via the FEP and that smaller changes can still move forward if this information is only available in a issue without needing a prior DR?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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


Therefore guidelines :need:`gd_temp__change_feature_request` and

Therefore guideline :need:`gd_temp__change_decision_record` is available. This guideline

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

gd_temp__change_decision_record is not really a guideline

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

replaced with template

All statements here for components are also valid for *SW Modules*.

As a rule of thumb, a Change Request is needed, if feature or component requirements
are changed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

maybe better "are changed in a way that also will cause a version update"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated

The Change Request implementation must be tracked until it is closed.

Use the content :ref:`Feature Request Template <chm_feature_templates>` or
:ref:`Component Request Template <chm_component_templates>` to document the implementation

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

better call "creation" instead "implementation" because at this point nothing is implemented (maybe a PoC).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

updated

For a CR that adds new functionality or changes behaviour, it is helpful to include a section on how to teach users, new and experienced, how to apply the CR to their work.


Rejected Ideas

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Seems to me covered by the DR alternatives. Also reference below to deleted "Rationale section"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

removed

Security Impact
===============

[How could a malicious user take advantage of this new/modified feature?]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this content moved somewhere or do we not need it any more? Maybe in the Impact Analysis Template?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

is part now of Impact Analysis Template

[What is the expected ASIL level?]


License Impact

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

do we consider this somewhere?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

is part now of Impact Analysis Template

A CR shall specify the stakeholder requirements as part of our platform/project.
Thereby the :need:`rl__project_lead` will approve these requirements as part of accepting the CR (e.g. merging the PR with the CR).

Backwards Compatibility

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

do we consider this somewhere?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

is part now of Impact Analysis Template

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.
out the impact on safety/security. Copy the relevant parts from the impact analysis

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

it is not clear what the "relevant parts" are. And why copy it? Copy it with content or only the headlines?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

formulated in better way, copy complete content or reference to the template

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants