Skip to content

Commit e0ed3c7

Browse files
authored
Merge pull request #2332 from eclipse-score/masc2023_link_feo_release_notes
update feo module safety plan
2 parents a4e97aa + 35d2b61 commit e0ed3c7

File tree

2 files changed

+19
-87
lines changed

2 files changed

+19
-87
lines changed

docs/modules/feo/docs/release/release_note.rst

Lines changed: 4 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
1515
.. document:: FEO Module Release Note
1616
:id: doc__feo_release_note
17-
:status: draft
17+
:status: valid
1818
:security: NO
1919
:safety: ASIL_B
2020
:realizes: wp__module_sw_release_note
@@ -25,70 +25,6 @@ FEO Module Release Note
2525
=======================
2626

2727

28-
| Module Name: FEO
29-
| Release Tag: vX.Y.Z
30-
| Origin Release Tag: vU.V.W
31-
| Release Commit Hash: a1b2c3d4e5f6g7h8i9j0
32-
| Release Date: YYYY-MM-DD
33-
|
34-
| Overview
35-
| --------
36-
|
37-
| This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z
38-
| as compared to the module's origin release (which is usually the previous release).
39-
|
40-
| Disclaimer
41-
| ----------
42-
| This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment.
43-
| The work products compiled in the safety package are created with care according to a process satisfying standards, but the as the project,
44-
| being a non-profit and open source organization, can not take over any liability for its content.
45-
|
46-
| New Features
47-
| ------------
48-
|
49-
| - **Feature 1**: Brief description of the new feature.
50-
| - **Feature 2**: Brief description of the new feature.
51-
| - **Feature 3**: Brief description of the new feature.
52-
|
53-
| Improvements
54-
| ------------
55-
|
56-
| - **Improvement 1**: Brief description of the improvement.
57-
| - **Improvement 2**: Brief description of the improvement.
58-
| - **Improvement 3**: Brief description of the improvement.
59-
|
60-
| Bug Fixes
61-
| ---------
62-
|
63-
| - **Bug 1**: Brief description of the bug fix.
64-
| - **Bug 2**: Brief description of the bug fix.
65-
| - **Bug 3**: Brief description of the bug fix.
66-
|
67-
| Compatibility
68-
| -------------
69-
|
70-
| - **Dependencies**: List any dependencies and their versions.
71-
|
72-
| Performed Verification
73-
| ----------------------
74-
| This release note is based on the verification as documented in module verification report
75-
| :need:`doc__feo_verification_report`.
76-
|
77-
| Known Issues
78-
| ------------
79-
|
80-
| - **Issue 1**: Brief description of the known issue. Justification regarding safety impact.
81-
| - **Issue 2**: Brief description of the known issue. Justification regarding safety impact.
82-
| - **Issue 3**: Brief description of the known issue. Justification regarding safety impact.
83-
|
84-
| Upgrade Instructions
85-
| --------------------
86-
|
87-
| 1. **Step 1**: Description of the first step.
88-
| 2. **Step 2**: Description of the second step.
89-
| 3. **Step 3**: Description of the third step.
90-
|
91-
| Contact Information
92-
| -------------------
93-
|
94-
| For any questions or support, please contact the *Project lead* or raise an issue/discussion.
28+
The release notes for FEO module version 1.0.2 can be found at:
29+
30+
`v1.0.2 <https://github.com/eclipse-score/feo/releases/tag/v1.0.2>`_

docs/modules/feo/docs/safety_mgt/module_safety_plan.rst

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -229,18 +229,14 @@ FEO Component Work Products List
229229
- <Link to WP>
230230
- <automated>
231231

232-
* - :need:`wp__sw_component_class`
233-
- :need:`gd_guidl__component_classification`
234-
- :ndf:`copy('status', need_id='gd_guidl__component_classification')`
235-
- https://github.com/eclipse-score/score/issues/1679
236-
- :need:`doc__feo_comp_class`
237-
- :ndf:`copy('status', need_id='doc__feo_comp_class')`
238232

239-
Note: In case the component is a new development, :need:`wp__sw_component_class` shall be removed from the above list (and also from the folders).
240-
In case an OSS element is used in the module, part 6 has to be filled out, depending on the component classification results.
233+
As feo is using score-crates as OSS component, the following section should be filled out
234+
accordingly.
235+
This section is currently only a placeholder and needs to be adapted based on the progress of the
236+
OSS qualification.
241237

242-
OSS (sub-)component qualification plan
243-
======================================
238+
OSS score-crates component qualification plan
239+
=============================================
244240

245241
For the selected OSS component the following work products will be implemented (and why):
246242

@@ -257,43 +253,43 @@ If the OSS element is classified as a
257253

258254
* - :need:`wp__requirements_comp`
259255
- <Link to issue>
260-
- Always needed (for Q and QR classification) and also improves process Id 2
256+
- Always needed (for Q and QR classification) and also improves process Id 2.
261257

262258
* - :need:`wp__requirements_comp_aou`
263259
- <Link to issue>
264-
- Always needed (for Q and QR classification) and also improves process Id 5
260+
- Always needed (for Q and QR classification) and also improves process Id 5.
265261

266262
* - :need:`wp__requirements_inspect`
267263
- n/a
268-
- Checklist used in Pull Request Review
264+
- Checklist used in Pull Request Review.
269265

270266
* - :need:`wf__cr_mt_comparch`
271267
- <Link to issue>
272-
- <Reasoning for tailoring, needed for example in case of deficits in process Id 3&4 and complexity Ids 1&4>
268+
- <Reasoning for tailoring, needed for example in case of deficits in process Id 3&4 and complexity Ids 1&4>.
273269

274270
* - :need:`wp__sw_component_fmea`
275271
- <Link to issue>
276-
- <Reasoning for tailoring, could help arguing too high cyclomatic complexity covered by safety mechanisms>
272+
- <Reasoning for tailoring, could help arguing too high cyclomatic complexity covered by safety mechanisms>.
277273

278274
* - :need:`wp__sw_arch_verification`
279275
- <Link to issue>
280-
- <Reasoning for tailoring, needed if also wf__cr_mt_comparch is required>
276+
- <Reasoning for tailoring, needed if also wf__cr_mt_comparch is required>.
281277

282278
* - :need:`wp__sw_implementation`
283279
- n/a
284280
- If source code is modified, this is not a OSS qualification any more.
285281

286282
* - :need:`wp__verification_sw_unit_test`
287283
- <Link to issue>
288-
- <Reasoning for tailoring, can improve deficits in process Id 6 and complexity Id 3>
284+
- <Reasoning for tailoring, can improve deficits in process Id 6 and complexity Id 3>.
289285

290286
* - :need:`wp__sw_implementation_inspection`
291287
- <Link to issue>
292-
- <Reasoning for tailoring, can improve deficits in process Id 6 and complexity Id 2>
288+
- <Reasoning for tailoring, can improve deficits in process Id 6 and complexity Id 2>.
293289

294290
* - :need:`wp__verification_comp_int_test`
295291
- <Link to issue>
296-
- Always needed (for Q and QR classification)
292+
- Always needed (for Q and QR classification).
297293

298294
* - :need:`wp__sw_component_class`
299295
- <Link to issue>

0 commit comments

Comments
 (0)