metrumresearchgroup / bbr

R interface for model and project management
https://metrumresearchgroup.github.io/bbr/
Other
23 stars 2 forks source link

Validation: creating bbr-requirements.yaml and modifying bbr-stories.yaml #493

Closed seth127 closed 2 years ago

seth127 commented 2 years ago

This is an update to our validation process. Where we previously linked user stories directly to tests that confirm the associated functionality, going forward we will link user stories to requirements that need to be met to satisfy the story, and then link those requirements to tests that confirm them.

seth127 commented 2 years ago

@kyleam @barrettk @rymarinelli tagging you all for visibility here. I put @barrettk on to review this, but any of you could. Probably pull this and run build-validation-docs.R to make sure it works for you and builds docs that look good.

To be clear, this is only to generate the new requirements YAML file. We will be manually adding to that file going forward, not pulling the descriptions from test names as we do here.

barrettk commented 2 years ago

@seth127 the validation docs didnt build for me. I didnt see a new version of mrgvalprep to be installed via pkgr. Is there anything else I need to do before generating the docs? image image

kyleam commented 2 years ago

@barrettk You'll need to install mrgvalprep from its latest develop branch to get the fix from https://github.com/metrumresearchgroup/mrgvalprep/pull/43