Updated Writing high quality testing instructions (markdown)

Alejandro López Ariza 2023-05-31 15:02:37 +02:00
parent 5777c7d810
commit 30b2b60d68
1 changed files with 11 additions and 1 deletions

@ -1,5 +1,15 @@
## What is a test?
## Introduction
Having clear testing Instructions on Pull Requests is the first level of quality engineering in WooCommerce, which is key for testing early and minimize the impact of unexpected side effects in the upcoming versions of WooCommerce.
This page contains the following sections:
* [What is a test?](https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions/_edit#what-is-a-test)
* [What to cover with the testing instructions](https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions/_edit#what-to-cover-with-the-testing-instructions)
* [Flow to write good testing instructions](https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions/_edit#flow-to-write-good-testing-instructions)
* [Examples](https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions/_edit#examples)
## What is a test?
A test is a method that we can use to check that something meets certain criteria. It is typically defined as a procedure which contains the steps required to put the system under test in a certain state before executing the action to be checked. Therefore, a test consists of the following stages:
- **Preconditions:** All the steps that need to be performed to put the system in the desired state before executing the action we want to check. A test could have many preconditions.
- **Action:** This is the exact step that causes the change we want to check in the system. It should be only one because each test should ideally cover one thing at a time.