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 why items on the quality review checklist are needed #181

Open
sarahcollyer opened this issue May 9, 2024 · 1 comment
Open

Add why items on the quality review checklist are needed #181

sarahcollyer opened this issue May 9, 2024 · 1 comment

Comments

@sarahcollyer
Copy link
Contributor

The quality review checklists don't explain why each item is needed. We should consider adding a column to provide clear explanations of how the item contributes to quality code and why it is important to review it.

@RichardP-tt
Copy link

RichardP-tt commented May 10, 2024

There do seem to be explanations in your guidance sections for each 'topic' heading, e.g. Modular Code, but they are not easily found from the checklist. Maybe a simple fix is links in the checklist?, e.g. Modular Code section of the checklist could link here https://best-practice-and-impact.github.io/qa-of-code-guidance/modular_code.html

It would be great if the 'why' were expressed as risks, then there could be a Risk Rating column, and an Action column (the risk control action) - we find both to be useful additions. We also add a column for 'Evidence/comments' where the assurer can put links to the evidence for the decisions/ratings (e.g. code snippet with line number) and also rationale if needed.

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

No branches or pull requests

2 participants