This page has suggestions for developers on how to write good testing instructions for the weekly testing of integrated issues.
We recommend that you:
- Number the steps in your test, and make use of sub-lists.
- Only put one action (preparation or validation) on each line - A step should only define a unique operation.
- Be explicit when a configuration setting, plugin, etc needs to be enabled - saying "Enable x" is not sufficient, instead consider outlining where the user needs to go and what they need to do to enable x. As a rule of thumb, try to write these steps as if the tester has never used Moodle before.
- Promote test validations - Confirm, Verify or Ensure - should be in bold so that they are easily identifiable.
- Make use of the Jira Markdown formatting.
In addition, the following items may be included:
- Setup requirements. If so, explain them with detailed information and/or provide a link to the documentation, for example https://docs.moodle.org/en/OAuth_2_services.
- Whether testing involves git/shell interaction, SQL operations or commands in general, don't assume the tester knows how to perform that stuff. Instead, add them explicitly to the instructions.
- Whether multiple themes (for example boost, or classic) should be used.
- Whether more than one browser should be used.
- Whether extra testing around the issue is required.
You should specify which themes and browsers have tested, and attach some screenshots.