Updated Writing high quality testing instructions (markdown)

nigeljamesstevenson 2024-01-17 11:17:23 +00:00
parent 00f150b61c
commit 390e08339b
1 changed files with 2 additions and 1 deletions

@ -62,7 +62,8 @@ Therefore, a PR could have testing instructions for multiple scenarios, in fact,
- If the testing instructions require to add custom code, please **provide the code snippet**.
- If the testing instructions require to install a plugin, please **provide a link to this plugin, or the zip file** to install it.
- If the testing instructions require to hit an API endpoint, please provide the **link to the endpoint documentation**.
- Ideally **provide screenshots and/or videos** that supported what the testing instructions are explaining. If you are using links to collaborative tools then also provide an equivalent screenshot/video for those who do not have access.
- Ideally **provide screenshots and/or videos** that supported what the testing instructions are explaining. If you are using links to collaborative tools then also provide an equivalent screenshot/video for those who do not have access.
- If the testing instructions are developer-centric e.g. require unit tests to be set up locally or perform updates to their installation, please consider additional testing instructions for folks who might be testing and not have such a setup.
## Examples