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.
Currently most of our content on continuous integration is under `Version control -> GitHub -> GitHub Actions`. It might be more useful and navigable if we had a tool-agnostic section...
Add: - [ ] Quarto - [ ] a11ytables - [ ] hamilton (python) - [ ] chispa - [ ] splink - [ ] fusen
Update organisation references, including: - [ ] Replacing BPI in footer - [ ] Removing GSS website links - [ ] Consider replacing GSS Help email
We currently only cover logging with a couple of bullet points in the QA checklists. It might be helpful to include more information, for example why we should do it...
- [ ] - Change configuration section to reflect that you should use a separate config file and version control this separately to the code, so that they can be...
Those managing coding projects or new to coding may find a glossary useful. This should explain the common terms and tools in simplified language.
Probably a good idea to add comments to your example code saying if it is demonstrating good or bad practice
We should clarify that review should be iterative and continuous during development, rather than just a final sign off process. It's simpler to address issues early on.
We need to point users to the RAP pathway for learning the relevant skills, before they use the book to refine their good practices.
When viewing the book, I cannot access the https://best-practice-and-impact.github.io/qa-of-code-guidance/version_control.html page as it is blocked by the Department of Health and Social Care firewall. I have queried with our IT services...
Metadata
Owner
Metadata
Guidance for quality assurance of code for civil service researchers and analysts.