Skip to content

add security aou to folder structure #3199

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
masc2023 merged 2 commits into from
Aug 20, 2026
Merged

add security aou to folder structure #3199

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32ae9ef
add security aou to folder structure
RolandJentschETAS Aug 20, 2026
448fda6
remove examples
RolandJentschETAS Aug 20, 2026
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
124 changes: 70 additions & 54 deletions docs/contribute/general/folder.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,18 +128,20 @@ See also `module template repository <https://github.com/eclipse-score/module_te

<module_name>/ -> Folder containing all artifacts corresponding to one module.
│ As folder optional if the repository only contains a single module.
├── .github/ -> GitHub configuration
│ └── workflows/ -> CI/CD pipelines
├── docs/ -> Documentation of the module
│ ├── features/ -> All features of the module.
│ │ └── <feature_name>/ -> Features including sub-folders and feature/component (change) request
│ │ │ [:need:`wp__feat_request`], [:need:`wp__cmpt_request`]
│ │ ├── architecture/ -> Feature architecture
│ │ │ [:need:`wp__feature_arch`], [:need:`wp__sw_arch_verification`]
│ │ ├── safety_analysis/ -> Safety analysis on feature level
│ │ │ [:need:`wp__feature_fmea`], [:need:`wp__feature_dfa`]
│ │ │ [:need:`wp__feature_fmea`], [:need:`wp__feature_dfa`], [:need:`wp__requirements_feat_aou`]
│ │ ├── safety_planning/ -> Feature specific safety workproducts planning
│ │ │ [:need:`wp__platform_safety_plan`]
│ │ ├── security_analysis/ -> Security analysis on feature level
│ │ │ [:need:`wp__feature_security_analysis`]
│ │ │ [:need:`wp__feature_security_analysis`], [:need:`wp__requirements_feat_aou`]
│ │ └── security_planning/ -> Feature specific security workproducts planning
│ │ [:need:`wp__platform_security_plan`]
│ ├── module/ -> Module documentation
Expand Down Expand Up @@ -168,31 +170,37 @@ See also `module template repository <https://github.com/eclipse-score/module_te
│ │ module SW bill of material [:need:`wp__sw_module_sbom`]
│ └── verification_report/ -> Module verification report
│ module verifications [:need:`wp__verification_module_ver_report`],
└── score/ -> Folder containing all artifacts corresponding to the components of the module.
├── <component_name>/ -> Components of the module.
│ │ Folder containing all artifacts corresponding to one component.
│ ├── docs/ -> Documentation of the component
│ │ ├── architecture/ -> Component architecture (only if lower level components exist)
│ │ │ [:need:`wp__component_arch`].
│ │ ├── detailed_design/ -> Detailed Design [:need:`wp__sw_implementation`] and
│ │ │ Detail design + code inspection [:need:`wp__sw_implementation_inspection`],
│ │ ├── manuals/ -> User documentation of a single component
│ │ │ (e.g., user manual of a library, optional)
│ │ │ (could contain optional subfolders for configuration guide,
│ │ │ examples user guide, APIs & usage, performance analysis, see module manual folder)
│ │ ├── requirements/ -> Component requirements [:need:`wp__requirements_comp`],
│ │ │ requirements inspection [:need:`wp__requirements_inspect`]
│ │ ├── safety_analysis/ -> Safety analysis on component level (only if component architecture exists)
│ │ │ [:need:`wp__sw_component_fmea`], [:need:`wp__sw_component_dfa`]
│ │ └── security_analysis/ -> Security analysis on component level (only if component architecture exists)
│ ├── src/ -> Source files of the component consisting of
│ | │ Include and source Files [:need:`wp__sw_implementation`]
│ | │ Unit tests [:need:`wp__verification_sw_unit_test`]
│ | └── <lower_level_comp>/ -> lower level component following <component_name> folder structure
│ └── tests/ -> Component-level tests (e.g., integration tests)
│ [:need:`wp__verification_comp_int_test`]
└── tests/ -> Module-level tests (e.g., feature integration tests, system tests)
[:need:`wp__verification_feat_int_test`]
├── score/ -> Folder containing all artifacts corresponding to the components of the module.
│ ├── <component_name>/ -> Components of the module.
│ │ │ Folder containing all artifacts corresponding to one component.
│ │ ├── docs/ -> Documentation of the component
│ │ │ ├── architecture/ -> Component architecture (only if lower level components exist)
│ │ │ │ [:need:`wp__component_arch`], [:need:`wp__sw_arch_verification`].
│ │ │ ├── detailed_design/ -> Detailed Design [:need:`wp__sw_implementation`] and
│ │ │ │ Detail design + code inspection [:need:`wp__sw_implementation_inspection`],
│ │ │ ├── manuals/ -> User documentation of a single component
│ │ │ │ (e.g., user manual of a library, optional)
│ │ │ │ (could contain optional subfolders for configuration guide,
│ │ │ │ examples user guide, APIs & usage, performance analysis, see module manual folder)
│ │ │ ├── requirements/ -> Component requirements [:need:`wp__requirements_comp`],
│ │ │ │ requirements inspection [:need:`wp__requirements_inspect`]
│ │ │ ├── safety_analysis/ -> Safety analysis on component level (only if component architecture exists)
│ │ │ │ [:need:`wp__sw_component_fmea`], [:need:`wp__sw_component_dfa`], [:need:`wp__requirements_comp_aou`]
│ │ │ │ component classification [:need:`wp__sw_component_class`] for pre-existing software
│ │ │ └── security_analysis/ -> Security analysis on component level (only if component architecture exists)
│ │ │ [:need:`wp__sw_component_security_analysis`], [:need:`wp__requirements_comp_aou`]
│ │ ├── src/ -> Source files of the component consisting of
│ │ | │ Include and source Files [:need:`wp__sw_implementation`]
│ │ | │ Unit tests [:need:`wp__verification_sw_unit_test`]
│ │ | └── <lower_level_comp>/ -> lower level component following <component_name> folder structure
│ │ └── tests/ -> Component-level tests (e.g., integration tests)
│ │ [:need:`wp__verification_comp_int_test`]
│ └── tests/ -> Module-level tests (e.g., feature integration tests, system tests)
│ [:need:`wp__verification_feat_int_test`]
├── MODULE.bazel -> Bazel module definition
├── BUILD -> Root build rules
├── project_config.bzl -> Project metadata used by Bazel macros
└── README.md -> Entry point of the repository

.. note::

Expand All @@ -211,16 +219,18 @@ For identification of the single feature, the repository name or module name sho

<module_name>/ -> Folder containing all artifacts corresponding to one module.
│ As folder optional if the repository only contains a single module.
├── .github/ -> GitHub configuration
│ └── workflows/ -> CI/CD pipelines
├── docs/ -> Documentation of the module
│ ├── features/ -> Feature folder parts for each feature which should be in module documentation
│ | ├── architecture/ -> Feature architecture
│ | │ [:need:`wp__feature_arch`], [:need:`wp__sw_arch_verification`]
│ | ├── safety_analysis/ -> Safety analysis on feature level
│ | │ [:need:`wp__feature_fmea`], [:need:`wp__feature_dfa`]
│ | │ [:need:`wp__feature_fmea`], [:need:`wp__feature_dfa`], [:need:`wp__requirements_feat_aou`]
│ | ├── safety_planning/ -> Feature specific safety workproducts planning
│ | │ [:need:`wp__platform_safety_plan`]
│ | ├── security_analysis/ -> Security analysis on feature level
│ | │ [:need:`wp__feature_security_analysis`]
│ | │ [:need:`wp__feature_security_analysis`], [:need:`wp__requirements_feat_aou`]
│ | └── security_planning/ -> Feature specific security workproducts planning
│ │ [:need:`wp__platform_security_plan`]
│ ├── module/ -> Module documentation
Expand Down Expand Up @@ -249,28 +259,34 @@ For identification of the single feature, the repository name or module name sho
│ │ module SW bill of material [:need:`wp__sw_module_sbom`]
│ └── verification_report/ -> Module verification report
│ module verifications [:need:`wp__verification_module_ver_report`],
└── score/ -> Folder containing all artifacts corresponding to the components of the module.
├── <component_name>/ -> Components of the module.
│ │ Folder containing all artifacts corresponding to one component.
│ ├── docs/ -> Documentation of the component
│ │ ├── architecture/ -> Component architecture (only if lower level components exist)
│ │ │ [:need:`wp__component_arch`].
│ │ ├── detailed_design/ -> Detailed Design [:need:`wp__sw_implementation`] and
│ │ │ Detail design + code inspection [:need:`wp__sw_implementation_inspection`],
│ │ ├── manuals/ -> User documentation of a single component
│ │ │ (e.g., user manual of a library, optional)
│ │ │ (could contain optional subfolders for configuration guide,
│ │ │ examples user guide, APIs & usage, performance analysis, see module manual folder)
│ │ ├── requirements/ -> Component requirements [:need:`wp__requirements_comp`],
│ │ │ requirements inspection [:need:`wp__requirements_inspect`]
│ │ ├── safety_analysis/ -> Safety analysis on component level (only if component architecture exists)
│ │ │ [:need:`wp__sw_component_fmea`], [:need:`wp__sw_component_dfa`]
│ │ └── security_analysis/ -> Security analysis on component level (only if component architecture exists)
│ ├── src/ -> Source files of the component consisting of
│ | │ Include and source Files [:need:`wp__sw_implementation`]
│ | │ Unit tests [:need:`wp__verification_sw_unit_test`]
│ | └── <lower_level_comp>/ -> lower level component following <component_name> folder structure
│ └── tests/ -> Component-level tests (e.g., integration tests)
│ [:need:`wp__verification_comp_int_test`]
└── tests/ -> Module-level tests (e.g., feature integration tests, system tests)
[:need:`wp__verification_feat_int_test`]
├── score/ -> Folder containing all artifacts corresponding to the components of the module.
│ ├── <component_name>/ -> Components of the module.
│ │ │ Folder containing all artifacts corresponding to one component.
│ │ ├── docs/ -> Documentation of the component
│ │ │ ├── architecture/ -> Component architecture (only if lower level components exist)
│ │ │ │ [:need:`wp__component_arch`], [:need:`wp__sw_arch_verification`].
│ │ │ ├── detailed_design/ -> Detailed Design [:need:`wp__sw_implementation`] and
│ │ │ │ Detail design + code inspection [:need:`wp__sw_implementation_inspection`],
│ │ │ ├── manuals/ -> User documentation of a single component
│ │ │ │ (e.g., user manual of a library, optional)
│ │ │ │ (could contain optional subfolders for configuration guide,
│ │ │ │ examples user guide, APIs & usage, performance analysis, see module manual folder)
│ │ │ ├── requirements/ -> Component requirements [:need:`wp__requirements_comp`],
│ │ │ │ requirements inspection [:need:`wp__requirements_inspect`]
│ │ │ ├── safety_analysis/ -> Safety analysis on component level (only if component architecture exists)
│ │ │ │ [:need:`wp__sw_component_fmea`], [:need:`wp__sw_component_dfa`], [:need:`wp__requirements_comp_aou`]
│ │ │ │ component classification [:need:`wp__sw_component_class`] for pre-existing software
│ │ │ └── security_analysis/ -> Security analysis on component level (only if component architecture exists)
│ │ │ [:need:`wp__sw_component_security_analysis`], [:need:`wp__requirements_comp_aou`]
│ │ ├── src/ -> Source files of the component consisting of
│ │ | │ Include and source Files [:need:`wp__sw_implementation`]
│ │ | │ Unit tests [:need:`wp__verification_sw_unit_test`]
│ │ | └── <lower_level_comp>/ -> lower level component following <component_name> folder structure
│ │ └── tests/ -> Component-level tests (e.g., integration tests)
│ │ [:need:`wp__verification_comp_int_test`]
│ └── tests/ -> Module-level tests (e.g., feature integration tests, system tests)
│ [:need:`wp__verification_feat_int_test`]
├── MODULE.bazel -> Bazel module definition
├── BUILD -> Root build rules
├── project_config.bzl -> Project metadata used by Bazel macros
└── README.md -> Entry point of the repository
Loading