Skip to content

Remove Covered attribute from req process#739

Merged
aschemmel-tech merged 2 commits into
mainfrom
aschemmel-tech-remove-reqcovered
Jul 8, 2026
Merged

Remove Covered attribute from req process#739
aschemmel-tech merged 2 commits into
mainfrom
aschemmel-tech-remove-reqcovered

Conversation

@aschemmel-tech

Copy link
Copy Markdown
Contributor

Refers: #664

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

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

* Title and description: For formulating requirements, the following template shall be used :need:`[[title]]<gd_temp__req_formulation>`
* ID: The naming convention for the ID is defined for every project in a central place (e.g. in the general contributor's guidelines)
* Furthermore the requirements need to be versioned. Therefore, a hash value of the requirement will to be calculated. The concept is described: :ref:`traceability concept for requirements`
* Furthermore the requirements need to be versioned to document content changes.

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.

There was a comment from @MaximilianSoerenPollak somewhere, we need to define changes, so e.g. removing typos is not a change. Propose to add here some general statement, what is expected to be a change

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 currently have a discussion / issue here in DaC about this topic.

eclipse-score/docs-as-code#622

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

* - Description
- In this attribute the content for the requirement will be specified. Please be aware that a note in a requirement is not part of the requirement itself. This means that notes should only be used to give additional explanation or context to the requirement.
* - Version
- Version updated whenever an attribute changed which may affect the linked child requirements.

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.

see above

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

explained a little further below

* - Attribute link
- What is significant
* - :need:`gd_req__req_attr_description`
- Functional changes shall lead to a version change, no formal corrections or modifications of the notes

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.

see above, needs more detailed explanation, typos, pure formal adaptions are changes?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated description

@aschemmel-tech aschemmel-tech force-pushed the aschemmel-tech-remove-reqcovered branch from 6613e9d to c50edb7 Compare July 7, 2026 13:36
@aschemmel-tech aschemmel-tech force-pushed the aschemmel-tech-remove-reqcovered branch from c50edb7 to a6f5c65 Compare July 7, 2026 13:42

@masc2023 masc2023 left a comment

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.

Fine for me now

@masc2023

masc2023 commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

@MaximilianSoerenPollak , any concerns, otherwise we can merge it

:status: valid
:version: 1
:tags: requirements_engineering
:version: 2

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.

Why is this version changed?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rst file was not modified, but the linked requirements_workflow.drawio.svg (and thus the html docu).

@MaximilianSoerenPollak MaximilianSoerenPollak left a comment

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.

Looks fine to me, just that one question regarding the version of that req.

@aschemmel-tech aschemmel-tech merged commit 65d7251 into main Jul 8, 2026
5 checks passed
@aschemmel-tech aschemmel-tech deleted the aschemmel-tech-remove-reqcovered branch July 8, 2026 05:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants