Testing instructions guide
This content of this page has been updated and migrated to the new Moodle Developer Resources. The information contained on the page should no longer be seen up-to-date.
Why not view this page on the new site and help us to migrate more content to the new site!
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.
- 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, provide a link to the documentation e.g. https://docs.moodle.org/en/OAuth_2_services if necessary writing something in the dev docs.
- Whether testing involves git/shell interaction, SQL operations... (commands in general), don't assume the tester knows how to perform that stuff. Instead, add them explicitly to the instructions.
- Whether testing may be done using the Moodle QA testing site.
- Whether multiple themes (current themes being Boost and Clean for old versions and Boost and Classic for 3.7 and up) should be used.
- Whether more than one browser should be used. (Tester should specify which browsers they used.)
- Whether extra testing around the issue is required.