Skip to content
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.

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

[REQ] Manually traced requirements #4

Closed
mhatzl opened this issue Aug 22, 2023 · 0 comments · Fixed by #12
Closed

[REQ] Manually traced requirements #4

mhatzl opened this issue Aug 22, 2023 · 0 comments · Fixed by #12
Labels
req-ready Marks this REQ issue as being ready for implementation waiting-on-assignee Issue/PR author or reviewer is awaiting response from assignee

Comments

@mhatzl
Copy link
Owner

mhatzl commented Aug 22, 2023

Not all requirements can be traced.
To still allow some form of tracing, it should be possible to annotate requirements that they require manual verification.

A possible approach would be to add a manual flag to the references list instead of the ref-cnt.
This would also integrate well with the general ref-cnt approach.

Example:

# my_req: Some Title

**References:**

- in branch main: manual

At some point, it might be possible that references are added for manually verified requirements.
In that case, the manual flag must not be removed, because manual verification might still be necessary,
but the ref-cnt should be added after the flag to indicate that references in code exist.

Example:

# my_req: Some Title

**References:**

- in branch main: manual + 1
@mhatzl mhatzl added req-missing-wiki-entry This REQ issue is not yet documented in the wiki waiting-on-assignee Issue/PR author or reviewer is awaiting response from assignee labels Aug 22, 2023
@mhatzl mhatzl added req-ready Marks this REQ issue as being ready for implementation and removed req-missing-wiki-entry This REQ issue is not yet documented in the wiki labels Sep 6, 2023
@mhatzl mhatzl closed this as completed in 58c8531 Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
req-ready Marks this REQ issue as being ready for implementation waiting-on-assignee Issue/PR author or reviewer is awaiting response from assignee
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant