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

Add option to check derived requirements have rationale #142

Open
robertberrington opened this issue Aug 22, 2014 · 5 comments
Open

Add option to check derived requirements have rationale #142

robertberrington opened this issue Aug 22, 2014 · 5 comments

Comments

@robertberrington
Copy link

robertberrington commented Aug 22, 2014

This is a common Requirements Standards item. DO-178 requires this, I'm pretty sure.

@jacebrowning jacebrowning added this to the v0.9 milestone Aug 22, 2014
@jacebrowning
Copy link
Member

Currently, Item does not have a rationale field. I'll have to think about whether this should be added or this feature should be left to custom project hooks.

@jacebrowning jacebrowning modified the milestones: v0.9, backlog Oct 14, 2014
@robertberrington
Copy link
Author

I could go either way on this. Recently I moved all my "Notes", "Comments" and "Rationale" directly into the item's text. It would seem straight forward enough to have a project hook that scanned derived = TRUE, the searched item.text for rationale followed by text.

The advantage is that adding "Notes", "Comments" and "Rationale" to item.text is that it is included in the review and link status, which could be an important aspect of requirement.

On the other hand, many Requirements Standards would required any "derived requirement" to have a rationale since it is not linked to anything ... it should have a reason to exist.

Either way, you might consider adding a "check for derived requirement has rationale" option to the standard checks regardless of if the rationale is in an item.text or item.rationale field.

$ doorstop --no-rationale-check "do not WARN if rationale is missing from derived requirements"

This allows a rationale check to be elevated to ERROR with the --error-all option.

@jacebrowning
Copy link
Member

This all sounds worthwhile to me. I'll consider this a request to:

  • add item.rationale that only gets published if it exists
  • add a check for a rationale on derived requirements
  • add an option --no-rationale-check to disable this check

@jacebrowning jacebrowning modified the milestones: v0.10, backlog Dec 3, 2014
@jacebrowning jacebrowning removed this from the v0.10 milestone Jan 29, 2015
@robertberrington robertberrington removed this from the v0.10 milestone Jan 29, 2015
@jacebrowning jacebrowning added this to the current milestone Jan 29, 2015
@blastur
Copy link
Collaborator

blastur commented Mar 1, 2017

Does the 'ready' tag indicate that this request has been implemented? Because I don't think it has, at least it's not merged.

I was looking for a way to specify a rationale that is separated from the text, this would do the job.

@jacebrowning
Copy link
Member

ready means that the story is ready to be worked on: https://waffle.io/jacebrowning/doorstop

@jacebrowning jacebrowning removed this from the current milestone Jun 27, 2019
@jacebrowning jacebrowning removed the ready label Jul 4, 2019
@neerdoc neerdoc added this to the v2.4 milestone Mar 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants