qa-of-code-guidance
qa-of-code-guidance copied to clipboard
best-practice-and-impact
Guidance for quality assurance of code for civil service researchers and analysts.
Add a GitHub workflow that tests all links in markdown files. This will help to find broken links rather than waiting for someone to notice them.
Currently have suggested linters and formatters for R and Python. It would be good to also add some for markdown to the list.
For the line "[- Configuration files are version controlled separately to the analysis code, so that they can be updated independently.](https://github.com/best-practice-and-impact/qa-of-code-guidance/blob/e36f7a9283c2a54702ef07dc3d58fee7910fc899/book/checklist_higher.md?plain=1#L69)" is this intended to mean configuration files are stored...
Parts of the book (version control in particular) contain instructions on how to use tools. Where possible, convert this to guidance that outlines good practices. Otherwise, remove content and create...
Add examples of skipped tests (and more strong wording around the risks of this.)
Version Control page feels repetitive with multiple sections referring to not including sensitive info. I think this could be rearranged or rewritten.
[For example](https://stackoverflow.com/questions/754527/best-way-to-test-sql-queries/754570#754570)
In project documentation, projects should indicate which development standards they are applying (e.g. linking to the Duck Book) We find that many teams reference the Duck Book as a general...
@shilohd described a case where a statistical model (Markov chain) gave different outcomes on different hardware and operating systems. Demonstrates that Docker or similar may be required for reproducibility
We should describe when it might be more appropriate to [use trunk-based development over gitflow](https://www.atlassian.com/continuous-delivery/continuous-integration/trunk-based-development)
Metadata
Owner
Metadata
Guidance for quality assurance of code for civil service researchers and analysts.