Skip to content

enhance implementation checklist#95

Open
RolandJentschETAS wants to merge 1 commit into
mainfrom
enhance_implementation_checklist
Open

enhance implementation checklist#95
RolandJentschETAS wants to merge 1 commit into
mainfrom
enhance_implementation_checklist

Conversation

@RolandJentschETAS

Copy link
Copy Markdown
Contributor

This pull request updates the checklist for implementation inspections in the detailed design documentation. The main focus is on clarifying and expanding the inspection criteria to improve traceability and alignment between design documentation and source code.

Checklist criteria updates:

  • Added a new checklist item, IMPL_03_01, to verify that interface names in component documentation match the implemented interface names in the source code, ensuring consistency between documentation and code.
  • Revised and expanded the checklist item (now IMPL_03_02) to require both consistency between detailed design and source code and the establishment of traceability, including checks for naming and folder/file structure alignment with intended functionality.

@github-actions

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: cd81bba1-3d55-4e2c-88e7-1d07df4bf738
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'score_process', the root module requires module version score_process@1.5.4, but got score_process@1.6.0 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (23 packages loaded, 10 targets configured)

Analyzing: target //:license-check (77 packages loaded, 10 targets configured)

Analyzing: target //:license-check (78 packages loaded, 10 targets configured)

Analyzing: target //:license-check (86 packages loaded, 10 targets configured)

Analyzing: target //:license-check (137 packages loaded, 2611 targets configured)

Analyzing: target //:license-check (156 packages loaded, 5442 targets configured)

Analyzing: target //:license-check (160 packages loaded, 8141 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8151 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8151 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8151 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8151 targets configured)

Analyzing: target //:license-check (167 packages loaded, 10160 targets configured)

Analyzing: target //:license-check (167 packages loaded, 10160 targets configured)

Analyzing: target //:license-check (167 packages loaded, 10160 targets configured)

Analyzing: target //:license-check (167 packages loaded, 10160 targets configured)

Analyzing: target //:license-check (167 packages loaded, 10160 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10280 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10280 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10280 targets configured)

INFO: Analyzed target //:license-check (169 packages loaded, 11859 targets configured).
[9 / 16] [Prepa] Expanding template external/score_tooling+/dash/tool/formatters/dash_format_converter [for tool]
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 215.058s, Critical Path: 2.45s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

@github-actions

Copy link
Copy Markdown

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

- Check if the static and dynamic design descriptions match the code (e.g. naming of elements)
and that the respective traceability is established
* - IMPL_03_01
- Do the interface names in component documentation match the implemented interface names of the unit?

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.

We should also name it as UIDs as used in all other process areas.

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

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants