Update baselibs feature requirements per inspection findings#3071
Conversation
4og
requested review from
FScholPer,
antonkri,
johannes-esr and
qor-lb
as code owners
|
I'm not sure if these kind of changes in requirements justify bumping to a new need version |
|
The created documentation from the pull request is available at: docu-html |
aschemmel-tech
left a comment
aschemmel-tech
left a comment
There was a problem hiding this comment.
see inline comments
| @@ -35,12 +35,12 @@ Requirements | |||
There was a problem hiding this comment.
version needs to be changed, already because of the security attribute change, same for other requirements. There is a description in https://eclipse-score.github.io/process_description/main/process_areas/requirements_engineering/requirements_concept.html#significant-requirement-changes
There was a problem hiding this comment.
I think we should also set the document version to 2
4og
force-pushed
the
4og_baselibs_req_inspection_fixes
branch
from
b235c29 to
969a05a
Compare
| The base libraries shall provide consistent APIs while respecting language-specific idioms. | ||
| The base libraries shall provide uniform API design patterns across all components while respecting language-specific idioms. | ||
|
|
||
| .. feat_req:: Maintainable Design |
There was a problem hiding this comment.
Drop this requirement as well. It is similar to architecture inspection checklist ARC_03_02
4og
force-pushed
the
4og_baselibs_req_inspection_fixes
branch
2 times, most recently
from
99d2ce5 to
d6f8bc2
Compare
| :derived_from: stkh_req__functional_req__base_libraries[version==1], stkh_req__dependability__automotive_safety[version==1] | ||
| :satisfied_by: feat__baselibs[version==1] | ||
| :status: valid | ||
| :version: 1 |
There was a problem hiding this comment.
forgot to set one version 1 to 2
| - :need:`feat_req__baselibs__concurrency_library` | ||
| - https://github.com/eclipse-score/score/issues/2885 | ||
| - YES | ||
| - |
There was a problem hiding this comment.
Please keep some explanation why it is "YES" as one for the other entries. E.g. write "Missing links to :need:stkh_req__dependability__automotive_safety added with https://github.com/eclipse-score/score/issues/2885"
| - :need:`feat_req__baselibs__containers_library`: "container types not present in the C++ standard library" depends on which C++ standard is used. | ||
| - https://github.com/eclipse-score/score/issues/2885 | ||
| - YES | ||
| - |
There was a problem hiding this comment.
Please keep some explanation why it is "YES" as one for the other entries. E.g. write "Check is supported by tooling and no ambiguities present any more after inspection fixes."
| - :need:`feat_req__baselibs__memory_library`: Description uses "baselibs" while all other requirements use "base libraries". Internally inconsistent with naming convention used throughout the document. | ||
| - https://github.com/eclipse-score/score/issues/2885 | ||
| - YES | ||
| - |
There was a problem hiding this comment.
Please keep some explanation why it is "YES" as one for the other entries. E.g. write "No logical inconsistencies, minor naming issues fixed with https://github.com/eclipse-score/score/issues/2885"
| - Is the requirement *verifiable*? | ||
| - If at the time of the inspection already tests are created for the requirement, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_test_covered` shows this. In case the requirement is not sufficiently traced to test cases already, a test expert is invited to the inspection to give their opinion whether the requirement is formulated in a way that supports test development and the available test infrastructure is sufficient to perform the test. | ||
| - YES | ||
| - The following feature requirements are high-level and not directly testable |
There was a problem hiding this comment.
Do not remove this explanation why it is "YES"
| - all the feature requirements here inherit from :need:`stkh_req__functional_req__base_libraries`, which has a security set to YES. This means all the requirements here should also set this attribute to YES. | ||
| - https://github.com/eclipse-score/score/issues/2885 | ||
| - YES | ||
| - |
There was a problem hiding this comment.
Please keep some explanation why it is "YES" as one for the other entries. E.g. write "all the feature requirements here inherit from :need:stkh_req__functional_req__base_libraries the security=yes"
- Link ASIL-B requirements to stkh_req__dependability__automotive_safety - Make titles/naming consistent - Set :security: YES to inherit from parent stakeholder requirement - Replace feat_req__baselibs__core_utilities and feat_req__baselibs__safety with a more specific feat_req__baselibs__utils_library requirement - Add feat_req__baselibs__static_reflection_library requirement - Remove feat_req__baselibs__consistent_apis, feat_req__baselibs__maintainable_design, and feat_req__baselibs__security requirements - Mark all inspection checklist findings as passed
4og
force-pushed
the
4og_baselibs_req_inspection_fixes
branch
from
d6f8bc2 to
941290d
Compare
2 participants
Applies the fixes for the baselibs feature requirement inspection (#2812), tracked in eclipse-score/baselibs#189.
feat_req__baselibs__core_utilitiesandfeat_req__baselibs__safetywith a more specificfeat_req__baselibs__utils_library; removedfeat_req__baselibs__consistent_apis,feat_req__baselibs__maintainable_design, andfeat_req__baselibs__security; addedfeat_req__baselibs__static_reflection_library; pinned containers to the ISO C++17 standard library.stkh_req__dependability__automotive_safetyto all ASIL-B requirements that lacked it.:security: YESon all requirements to inherit fromstkh_req__functional_req__base_libraries.Fixes eclipse-score/baselibs#189