Module Safety plan status and role updates #447
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
|
|
||
| .. document:: [Your Component Name] Implementation Inspection Checklist | ||
| :id: doc__component_name_impl_inspection | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__sw_implementation_inspection | ||
| :tags: template | ||
|
|
||
| .. attention:: | ||
| The above directive must be updated according to your Component. | ||
|
|
||
| - Modify ``Your Component Name`` to be your Component Name | ||
| - Modify ``id`` to be your Component Name in lower snake case preceded by ``doc__`` and followed by ``_impl_inspection`` | ||
| - Adjust ``status`` to be ``valid`` | ||
| - Adjust ``safety``, ``security`` and ``tags`` according to your needs | ||
|
|
||
| Implementation Inspection Checklist | ||
| =================================== | ||
|
|
||
| Purpose | ||
| ------- | ||
|
|
||
| The purpose of this checklist is to collect the topics to be checked during implementation, | ||
| i.e. in the detailed design and the source code of the units. | ||
|
|
||
| The checklist shall be agnostic to which programming language is used. Differences shall be treated | ||
| by linking to C++ or Rust specific documentation. | ||
|
|
||
| Checklist | ||
| --------- | ||
|
|
||
| .. list-table:: Implementation Checklist | ||
| :header-rows: 1 | ||
| :widths: 10,30,50,6,6,8 | ||
|
|
||
| * - Review ID | ||
| - Acceptance Criteria | ||
| - Guidance | ||
| - Passed | ||
| - Remarks | ||
| - Issue link | ||
| * - IMPL_01_01 | ||
| - Is the design according to guidelines? | ||
| - see :need:`gd_temp__detailed_design` and :need:`doc_concept__imp_concept` | ||
| (e.g. are the views done with the proposed UML diagrams) | ||
| - | ||
| - | ||
| - | ||
| * - IMPL_01_02 | ||
| - Is the implementation according to specification? | ||
| - Check if the linked component requirements are fulfilled | ||
| and detailed design also matches architecture description. | ||
| - | ||
| - | ||
| - | ||
| * - IMPL_01_03 | ||
| - Are the design decisions and constraints documented? | ||
| - Check also for plausibility of these. | ||
| - | ||
| - | ||
| - | ||
| * - IMPL_01_04 | ||
| - Are all external libraries used by the component specified in the detailed design? | ||
| - Check the automated dependency analysis. | ||
| Also make sure ASIL rated units also only use ASIL or FFI rated libraries. | ||
| - | ||
| - | ||
| - | ||
| * - IMPL_02_01 | ||
| - Are the static and dynamic code analysis reports verified for violations? | ||
| - All violations in ASIL related code must be justified. This includes the checks of coding guidelines. | ||
| - | ||
| - | ||
| - | ||
| * - IMPL_02_02 | ||
| - Do manual checks, that are derived from the coding guideline, find no safety critical error? | ||
| - Check this list for C++ <link> and this list for Rust <link> | ||
|
||
| - | ||
| - | ||
| - | ||
| * - IMPL_02_03 | ||
| - Are detailed design and source code consistent? | ||
| - Check if the static and dynamic design descriptions match the code (e..g. naming of elements) | ||
|
||
| and that the respective traceability is established (doxygen style comments) | ||
|
||
| - | ||
| - | ||
| - | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have defined FFI rated libraries somewhere?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok, removed FFI