Testing instructions guide: Difference between revisions
From MoodleDocs
(one action per step) |
No edit summary |
||
| Line 2: | Line 2: | ||
We recommend that you: | We recommend that you: | ||
# Number the steps in your test, and make use of sub-lists. | # Number the steps in your test, and make use of sub-lists. | ||
# Only put one action (preparation or validation) on each line | # 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. | # Promote test validations - '''Confirm''', '''Verify''' or '''Ensure''' - should be in '''bold''' so that they are easily identifiable. | ||
# Make use of the [https://tracker.moodle.org/secure/WikiRendererHelpAction.jspa?section=all Jira Markdown formatting]. | # Make use of the [https://tracker.moodle.org/secure/WikiRendererHelpAction.jspa?section=all Jira Markdown formatting]. | ||
In addition, the following items may be included: | 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. | # 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 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. | ||
| Line 16: | Line 13: | ||
# Whether more than one browser should be used. (Tester should specify which browsers they used.) | # Whether more than one browser should be used. (Tester should specify which browsers they used.) | ||
# Whether extra testing around the issue is required. | # Whether extra testing around the issue is required. | ||
[[Category: Processes]] | [[Category: Processes]] | ||
Revision as of 04:37, 18 November 2021
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.
