+
Skip to content

add initial templates for feo feature and module #1633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 27, 2025
Merged

add initial templates for feo feature and module #1633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,5 +97,5 @@ bazel_dep(name = "score_cli_helper", version = "0.1.1")
bazel_dep(name = "score_starpls_lsp", version = "0.1.0")
# Checker rule for CopyRight checks/fixs

bazel_dep(name = "score_docs_as_code", version = "1.0.1")
bazel_dep(name = "score_process", version = "1.1.0")
bazel_dep(name = "score_docs_as_code", version = "1.0.2")
bazel_dep(name = "score_process", version = "1.1.1")
4 changes: 2 additions & 2 deletions docs/contribute/contribution_request/feature_request.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This Guideline is based on or references following documents:

* :ref:`Contribution Guideline <contribute_contribution_guideline>`
* :ref:`Change Management Plan <change_mgmt_plan>`
* :need:`Feature Template <PROCESS_gd_temp__change__feature_request>`
* :need:`Feature Template <PROCESS_gd_temp__change_feature_request>`

Creation of Feature Request
================================
Expand Down Expand Up @@ -79,7 +79,7 @@ First of all, change the status of *Feature Request* to "in Progress" state.
*Feature Requests*, that stay in the status "Draft" longer as 4 weeks, will be deleted.
Afterwards create a PR with your proposal in the `/docs/features <https://github.com/eclipse-score/score/tree/main/docs/features>`_ score repository.
There you will find currently existing features as subfolders. Please choose the one that fits your *feature request* the most or
create a new subfolder, if none of existing feature match your *feature request*. Please take care, that the PR follows the :need:`Feature Template <PROCESS_gd_temp__change__feature_request>`.
create a new subfolder, if none of existing feature match your *feature request*. Please take care, that the PR follows the :need:`Feature Template <PROCESS_gd_temp__change_feature_request>`.
You should try to put as much information as possible, as a good exhaustive description is a prerequisite for *feature request* to be accepted.

It is important to understand, that *feature request* consists of an GitHub Issue, that is used to track organizational information and
Expand Down
4 changes: 2 additions & 2 deletions docs/contribute/development/cpp/code_analysis.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Code Analysis C++
#################

.. document:: Static Code Analysis C++
:id: doc__cpp__code_analysis
:id: doc__cpp_code_analysis
:status: valid

Guideline for Static Code Analysis
Expand All @@ -25,7 +25,7 @@ Static Code Analysis
====================
In order to fulfil the S-CORE related standard requirements a concept for *Static Code Analysis* needs to be established. Input for the analysis is based upon *MISRA* and *ISO26262* standards in accordance to the :need:`doc__cpp_coding_guidelines`.

Checking those rules can partially be automated and implemented by a combination of different tools. Thus a mapping needs to be established which provides a linkage of all *MISRA* requirements to the respective tool requirements/rules. For *MISRA C++:2023* this mapping is established: :need:`here <doc__cpp__misra2023_rule_mapping>`
Checking those rules can partially be automated and implemented by a combination of different tools. Thus a mapping needs to be established which provides a linkage of all *MISRA* requirements to the respective tool requirements/rules. For *MISRA C++:2023* this mapping is established: :need:`here <doc__cpp_misra2023_rule_mapping>`

.. needuml::

Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/development/cpp/misra_2023_rule_mapping.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ MISRA C++:2023 Rule Mapping
###########################

.. document:: MISRA C++:2023 Rule Mapping
:id: doc__cpp__misra2023_rule_mapping
:id: doc__cpp_misra2023_rule_mapping
:status: draft

..
Expand Down
20 changes: 10 additions & 10 deletions docs/contribute/general/folder.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ The following shows the folder structure of the platform repository (ordered alp
features/ -> All features of the platform
<feature_name>/ -> Features including sub-folders and feature (change) request [:need:`PROCESS_wp__feat_request`]
architecture/ -> Feature architecture [:need:`PROCESS_wp__feature_arch`]
requirements/ -> Feature requirements [:need:`PROCESS_wp__requirements__feat`]
requirements/ -> Feature requirements [:need:`PROCESS_wp__requirements_feat`]
safety_analysis/ -> Safety analysis on feature level [:need:`PROCESS_wp__feature_fmea`], [:need:`PROCESS_wp__feature_dfa`]
safety_planning/ -> Feature specific safety workproducts planning
security_analysis/ -> Security analysis on feature level [:need:`PROCESS_wp__feature_security_analysis`]
verification/ -> Feature verification, consisting of Architecture review [:need:`PROCESS_wp__sw_arch_verification`],
integration_tests/ -> Feature Integration tests [:need:`PROCESS_wp__verification__feat_int_test`]
integration_tests/ -> Feature Integration tests [:need:`PROCESS_wp__verification_feat_int_test`]

glossary/ -> Glossary of abbreviations used in the platform context
introduction/ -> Background, scope and high-level architecture of the platform features
Expand All @@ -44,7 +44,7 @@ The following shows the folder structure of the platform repository (ordered alp
quality/ -> Quality documentation on platform level:
[:need:`PROCESS_wp__qms_report`]
requirements/ -> Requirements on platform level
stakeholder/ -> Stakeholder requirements [:need:`PROCESS_wp__requirements__stkh`]
stakeholder/ -> Stakeholder requirements [:need:`PROCESS_wp__requirements_stkh`]
tool/ -> Tool requirements (not covered in tool repositories)
safety/ -> Safety documentation on platform level (SEooC):
[:need:`PROCESS_wp__platform_dfa`], [:need:`PROCESS_wp__platform_safety_manual`],
Expand All @@ -55,9 +55,9 @@ The following shows the folder structure of the platform repository (ordered alp
security/ -> Security documentation on platform level:
[:need:`PROCESS_wp__platform_security_manual`], [:need:`PROCESS_wp__platform_security_package`], [:need:`PROCESS_wp__sw_platform_sbom`]
verification_report/ -> Platform verification report (reporting all platform feature's verifications)
[:need:`PROCESS_wp__verification__platform_ver_report`]
[:need:`PROCESS_wp__verification_platform_ver_report`]

platform_integration_tests/ -> Integration tests on reference hardware verifying stakeholder requirements. [:need:`PROCESS_wp__verification__platform_test`]
platform_integration_tests/ -> Integration tests on reference hardware verifying stakeholder requirements. [:need:`PROCESS_wp__verification_platform_test`]
tools/ -> Platform tools (not covered in tool repositories)

README.md -> Entrypoint of the repository
Expand All @@ -74,7 +74,7 @@ The modules and components shall follow the folder structure which was presented
<module_name>/ -> Folder containing all artifacts corresponding to one module.
docs/ -> Documentation of the module
manual/ -> Module manual, e.g. integration manual, assumptions of use,
safety manual [:need:`PROCESS_wp__requirements__comp_aou`],
safety manual [:need:`PROCESS_wp__requirements_comp_aou`],
[:need:`PROCESS_wp__module_safety_manual`],
security_manual [:need:`PROCESS_wp__module_security_manual`].
release/ -> Module release note [:need:`PROCESS_wp__module_sw_release_note`],
Expand All @@ -86,7 +86,7 @@ The modules and components shall follow the folder structure which was presented
formal documents reviews [:need:`PROCESS_wp__fdr_reports_security`],
module SW bill of material [:need:`PROCESS_wp__sw_module_sbom`]
verification_report/ -> Module verification report
components verifications [:need:`PROCESS_wp__verification__module_ver_report`],
components verifications [:need:`PROCESS_wp__verification_module_ver_report`],
safety analysis formal reviews [:need:`PROCESS_wp__fdr_reports`]

<component_name>/ -> Components of the module.
Expand All @@ -95,7 +95,7 @@ The modules and components shall follow the folder structure which was presented
src/ -> Source files of the component consisting of
Include files
Source Files
Unit tests [:need:`PROCESS_wp__verification__sw_unit_test`]
Unit tests [:need:`PROCESS_wp__verification_sw_unit_test`]
Test doubles
<lower_level_comp>/ -> lower level component following <component_name> folder structure
details/ -> Private implementation details of the component following <component_name> folder structure
Expand All @@ -104,12 +104,12 @@ The modules and components shall follow the folder structure which was presented
architecture/ -> Component architecture (only if lower level components exist)
[:need:`PROCESS_wp__component_arch`].
detailed_design/ -> Detailed Design [:need:`PROCESS_wp__sw_implementation`]
requirements/ -> Component requirements [:need:`PROCESS_wp__requirements__comp`]
requirements/ -> Component requirements [:need:`PROCESS_wp__requirements_comp`]
safety_analysis/ -> Safety analysis on component level (only if component architecture exists)
[:need:`PROCESS_wp__sw_component_fmea`], [:need:`PROCESS_wp__sw_component_dfa`]
security_analysis/ -> Security analysis on component level (only if component architecture exists)
[:need:`PROCESS_wp__sw_component_security_analysis`]
verification/ -> Component verification, consisting of Architecture review [:need:`PROCESS_wp__sw_arch_verification`],
code inspection [:need:`PROCESS_wp__sw_implementation_inspection`],
integration_tests/ -> Component integration tests [:need:`PROCESS_wp__verification__comp_int_test`]
integration_tests/ -> Component integration tests [:need:`PROCESS_wp__verification_comp_int_test`]
<lower_level_comp>/ -> Lower level component following <component_name> folder structure
32 changes: 16 additions & 16 deletions docs/features/communication/ipc/docs/safety_planning/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,29 +31,29 @@ Inter-process Communication Safety Work Products
- WP status

* - :need:`PROCESS_wp__feat_request`
- :need:`PROCESS_gd_temp__change__feature_request`
- :ndf:`copy('status', need_id='PROCESS_gd_temp__change__feature_request')`
- :need:`PROCESS_gd_temp__change_feature_request`
- :ndf:`copy('status', need_id='PROCESS_gd_temp__change_feature_request')`
- `#69 <https://github.com/eclipse-score/score/issues/69>`_
- :need:`doc__com_ipc`
- :ndf:`copy('status', need_id='doc__com_ipc')`

* - :need:`PROCESS_wp__requirements__feat`
- :need:`PROCESS_gd_temp__req__feat_req`
- :ndf:`copy('status', need_id='PROCESS_gd_temp__req__feat_req')`
* - :need:`PROCESS_wp__requirements_feat`
- :need:`PROCESS_gd_temp__req_feat_req`
- :ndf:`copy('status', need_id='PROCESS_gd_temp__req_feat_req')`
- `#69 <https://github.com/eclipse-score/score/issues/69>`_
- :doc:`../requirements/index`
- see below

* - :need:`PROCESS_wp__requirements__feat_aou`
- :need:`PROCESS_gd_temp__req__aou_req`
- :ndf:`copy('status', need_id='PROCESS_gd_temp__req__aou_req')`
* - :need:`PROCESS_wp__requirements_feat_aou`
- :need:`PROCESS_gd_temp__req_aou_req`
- :ndf:`copy('status', need_id='PROCESS_gd_temp__req_aou_req')`
- <link to issue>
- :doc:`../requirements/index`
- see below

* - :need:`PROCESS_wp__feature_arch`
- :need:`PROCESS_gd_temp__arch__feature`
- :ndf:`copy('status', need_id='PROCESS_gd_temp__arch__feature')`
- :need:`PROCESS_gd_temp__arch_feature`
- :ndf:`copy('status', need_id='PROCESS_gd_temp__arch_feature')`
- `#388 <https://github.com/eclipse-score/score/issues/388>`_
- :doc:`../architecture/index`
- see below
Expand All @@ -65,21 +65,21 @@ Inter-process Communication Safety Work Products
- <Link to WP>
- <automated>

* - :need:`PROCESS_wp__requirements__inspect`
- :need:`PROCESS_gd_chklst__req__inspection`
- :ndf:`copy('status', need_id='PROCESS_gd_chklst__req__inspection')`
* - :need:`PROCESS_wp__requirements_inspect`
- :need:`PROCESS_gd_chklst__req_inspection`
- :ndf:`copy('status', need_id='PROCESS_gd_chklst__req_inspection')`
- <link to issue>
- <Link to WP>
- <automated>

* - :need:`PROCESS_wp__sw_arch_verification`
- :need:`PROCESS_gd_chklst__arch__inspection_checklist`
- :ndf:`copy('status', need_id='PROCESS_gd_chklst__arch__inspection_checklist')`
- :need:`PROCESS_gd_chklst__arch_inspection_checklist`
- :ndf:`copy('status', need_id='PROCESS_gd_chklst__arch_inspection_checklist')`
- <link to issue>
- <Link to WP>
- <automated>

* - :need:`PROCESS_wp__verification__feat_int_test`
* - :need:`PROCESS_wp__verification_feat_int_test`
- :need:`PROCESS_gd_guidl__verification_guide`
- :ndf:`copy('status', need_id='PROCESS_gd_guidl__verification_guide')`
- <link to issue>
Expand Down
1 change: 1 addition & 0 deletions docs/features/frameworks/feo/architecture/_assets/stat_arch.puml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ component "logging/\ntracing" as log_trace_mgr
component "time" as time_mgr

frame "feo" as feo {
component "feo"
component "feo_com"
component "feo_log"
component "feo_time"
Expand Down
Loading
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载