qa-of-code-guidance
qa-of-code-guidance copied to clipboard
Guidance for quality assurance of code for civil service researchers and analysts.
Including: - [ ] Issues with discussions - [ ] Contribution and review via PR - [ ] Testing using CI
https://github.com/best-practice-and-impact/qa-of-code-guidance/pull/41#pullrequestreview-579085540
This subheading: https://best-practice-and-impact.github.io/qa-of-code-guidance/learning.html#learing-from-mistakes may have a typo. I think the first word should be 'learning' from mistakes, rather than 'learing'
Title - removed a duplicated paragraph in the Version Control chapter.
Configuration python examples use `yaml.load()`, which is deprecated, and `sys.argv < 2` will throw an error. I've updated to use `yaml.safe_load()` and fix the argument check to `len(sys.argv) < 2`....
Feedback from UKHSA. Some items on the lower code checklist may overlap or contain detail not relevant to the section it is under. We should review items and rewrite as...
Feedback from UKHSA: It would be nice to have a unique ID for each item, that will be the same for everybody using the Duck Book. As an example, this...
Currently the code quality review checklists are only available as text or Markdown. We've had feedback that it would be useful to also have them available in a tabular format.