diff --git a/quality-checks.md b/quality-checks.md index c7bcc197..a6e3c4fe 100644 --- a/quality-checks.md +++ b/quality-checks.md @@ -15,7 +15,8 @@ The checks are classified here based on the concerns they help to address: ## Usage -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. + +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. The [Details](#details) section lists universal checks in black, and contextual checks in grey.d 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. @@ -32,6 +33,8 @@ We rate our applications against each of these checks as follows: * Red = the quality check is not applied. * N/A = the quality check is not applicable. +There may be further nuances to these definitions, and the sections detailing each check can expand considerably on the criteria as required. Everyone is encouraged to contribute to those, and discuss how they can be best be tailored. + ## Tracking progress We recommend tracking progress on an Engineering Quality dashboard, for example: