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.
Higher checklist states: Design certificates confirm that the design is compliant with requirements. But no clarification on this is provided in the book. What would we expect to see to...
This formatting looks much clearer. Do we need to update quotes elsewhere in the book to match? Also consider including book subtitle for context (The Aqua Book: guidance on producing...
Only other thing is a general reminder of the [Hemingway app](https://hemingwayapp.com/), which can help pick up readability issues like a couple of the wordier sentences I flagged before _Originally posted...
Do we explain anywhere what the Aqua book is and that analysts are required to follow it? Also consider putting Aqua book quote next to this paragraph based on Aqua...
Do we talk about user needs elsewhere in the Duck Book? If not, might be worth making this a subsection in it's own right rather than an explanation of a...
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...
We should give a clearer steer on pinning dependency versions: - Packages of reusable code should use more than or equal to (e.g. `pandas>=1.0.0`) version for each dependency. This gives...
There are two actions based on SOLID OOP principles, but these are often not applicable and are worded very differently the other actions. We should clarify how SOLID principles apply...
Checklists currently expect "users to participate in peer review". This implies that users should be reviewing Pull Requests for example. So we should be clearer in stating that users should...
Add more information on how to structure tests. For example: * when should use you test classes (what are the benefits) * test file per module or function * best...
Metadata
Owner
Metadata
Guidance for quality assurance of code for civil service researchers and analysts.