Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quality checks format #208

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Quality checks format #208

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e6250f
Reformat quality checks
iw-ezequiel Oct 27, 2021
285c2af
Typos
iw-ezequiel Oct 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 48 additions & 5 deletions quality-checks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,11 @@ Quality checks are at the heart of good engineering, and are essential for rapid

The checks are classified here based on the concerns they help to address:

* Functionality
* Security
* Resilience
* Maintainability
* [Functionality](#1-functionality-checks)
* [Security](#2-security-checks)
* [Resilience](#3-resilience-checks)
* [Maintainability](#4-maintainability-checks)
* [General checks](#5-general-checks)

## Usage

Expand All @@ -38,7 +39,49 @@ We recommend tracking progress on an Engineering Quality dashboard, for example:

![Example Dashboard](images/quality-dashboard.png)

## Details

## 1. Functionality checks
* [Unit tests](#unit-tests-)
* [Integration tests](#integration-tests-)
* API/Contract tests
* UI Tests

### Unit Tests ![](https://img.shields.io/badge/-Universal-blue)
#### About
* What it is: Logic tests for individual blocks of code, e.g. individual methods.
* Why we care: This is the quickest (to execute) type of functional test, so these are essential to achieve both rapid and thorough functional testing.
* Endorsed tools/configuration: TBD
* Further details: See [Test practices](./practices/testing.md)

#### Thresholds
* ![](https://img.shields.io/badge/-Green-green) Builds fail if any tests fail.
* ![](https://img.shields.io/badge/-Amber-yellow) TBD

### Integration tests ![](https://img.shields.io/badge/-Universal-blue)
#### About
* What it is: Check interactions with other components and dependant systems. e.g. across microservices, authentication layers, database, third-party systems. Ideally includes full end-to-end testing across all components.
* Why we care: When components are developed in isolation, it's vital that we regularly test them working together. Changes in one component can break the whole system.
* Endorsed tools/configuration: TBD

#### Thresholds
* ![](https://img.shields.io/badge/-Green-green) Builds fail if any tests fail.
* ![](https://img.shields.io/badge/-Amber-yellow) TBD

## 2. Security checks
Checks here

## 3. Resilience checks
Checks here

## 4. Maintainability checks
Checks here

## 5. General checks




## --Deprecated below--Details

| Quality check | Classification | Applicability | What it means | Why we care | Tolerances for green | Endorsed tools / configuration | Further details |
| :--------------------- | :-------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------ |
Expand Down