Skip to content

Commit f8997a9

Browse files
authored
Merge pull request #207 from NHSDigital/quality-checks-usage
Update usage and RAG scale #206
2 parents 9d0b887 + f238a0d commit f8997a9

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

quality-checks.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,20 +15,22 @@ The checks are classified here based on the concerns they help to address:
1515

1616
## Usage
1717

18-
All applicable quality checks should be applied. Not all checks are applicable in all contexts, for example accessibility testing is only applicable to applications with a user interface.
18+
All applicable quality checks should be applied. Not all checks are universal, i.e. applicable in all contexts. For example, accessibility testing is only applicable to applications with a user interface.
1919

2020
The majority of these checks should be [automated](./patterns/automate-everything.md) via [continuous integration / continuous deployment](./practices/continuous-integration.md): the optimal sequencing of these checks within CI/CD pipelines will depend on the project's branching strategy, deployment strategy, etc.
2121

2222
All of these checks are important, even where their purpose overlaps with other checks in the list. For example, comprehensive functional testing could be achieved without unit testing, instead only using the other functional test types on this list - this would result in a very long-running and inefficient test suite, precluding fast feedback and impeding rapid and safe delivery of software changes. For further details please see [test practices](./practices/testing.md), and especially the [test pyramid](https://martinfowler.com/articles/practical-test-pyramid.html).
2323

24+
Although we separate resilience checks into their notional components, when it comes to implementation these may be joined up where useful. For example, an automated test suite may test the application for peak load and then drop down to sustained load in order to conduct a soak test.
25+
2426
## RAG scale
2527

2628
We rate our applications against each of these checks as follows:
2729

28-
* Green = the quality check is applied frequently and consistently (in practice this typically means [automated](./patterns/automate-everything.md) via [continuous integration / continuous deployment](./practices/continuous-integration.md)), the output of the check is a quality gate (as opposed to just a warning / for information), and the tolerances for that quality gate (e.g. code coverage %) are agreed and understood
29-
* Amber = the quality check is applied, but not all conditions for green are met - for example the check generates warnings that may or may not be acted on
30-
* Red = the quality check is not applied
31-
* N/A = the quality check is not applicable
30+
* Green = the quality check is applied frequently and consistently (in practice this typically means [automated](./patterns/automate-everything.md) via [continuous integration / continuous deployment](./practices/continuous-integration.md)), the output of the check is a quality gate (as opposed to just a warning / for information), and the tolerances for that quality gate (e.g. code coverage %) are agreed and understood.
31+
* Amber = the quality check is applied, but not all conditions for green are met - for example the check generates warnings that may or may not be acted on, or is executed on an ad-hoc basis and cannot offer a consistent quality gate guarantee.
32+
* Red = the quality check is not applied.
33+
* N/A = the quality check is not applicable.
3234

3335
## Tracking progress
3436

0 commit comments

Comments
 (0)