best-practice-and-impact / qa-of-code-guidance

Guidance for quality assurance of code for civil service researchers and analysts.
https://best-practice-and-impact.github.io/qa-of-code-guidance
Other
75 stars 18 forks source link

Create a Markdown/Quarto template for formal code reviews #136

Open foster999 opened 1 year ago

foster999 commented 1 year ago

We currently use Word/Excel docs to carry out our own reviews. It would be best if we shared a template that allows others to follow the same approach. Markdown/Quarto would be more suitable for including review outcomes in repos or general flexibility in format.

Create a template based on the higher quality assurance checklist, including our standard for ranking recommendations. It's worth considering if there's any way to dynamically generate this from the checklist page or the reverse, as it will change over time.