Note: You are currently viewing documentation for Moodle 3.8. Up-to-date documentation for the latest stable version of Moodle may be available here: How to add steps to reproduce to a bug report.

How to add steps to reproduce to a bug report: Difference between revisions

From MoodleDocs
(New page: ==Problem== Often a bug reporter is a developer or/and an expert Moodle user. By consequence he forgets to add the test steps into the description. ==Solution== '''When you know how''' t...)
 
(changes from 3.6 to 3.7)
 
(2 intermediate revisions by 2 users not shown)
Line 6: Line 6:


==The reasons==
==The reasons==
*the developer will love you: the steps are very useful for the developer in order to reproduce/test your issue. Think that sometimes the developer has the ability to fix a bug, but doesn't have yet your knowledge about the module containing this bug.<br>  
*the developer will be happy: the steps are very useful for the developer in order to reproduce/test your issue. Think that sometimes the developer has the ability to fix a bug, but doesn't have yet your knowledge about the module containing this bug.<br>  
*the QA manager will love you more: if you indicate the test steps, any QA tester would be able to retest and validate the fix during the weekly quality assurance process.
*the QA manager will be even more happy: if you indicate the test steps, any QA tester would be able to retest and validate the fix during the weekly quality assurance process.


=Example of test steps=
<code>
Environment:
Moodle 2.0 - Server run on Linux/Apache/MySQL


=Example of test steps=
Steps to reproduce:
    Environment: Moodle 2.0 - Server run on Linux/Apache/MySQL
1. Login as Admin
2. Go to a course page
3. Turn editing on
4. Add a "Label" resource
5. On the following page, enter some arbitrary label text
6. Press the Save button


    1. Connect as Admin<br>
Actual result:
    2. Go to a Course page > Turn editing on > Select Insert Label operation > Enter some details and Save<br>
On the following page, the label is not displayed on the course page
    => The new label is not displayed into the course page


    Expected result: a newly created label should be displayed into a course page
Expected result:  
On the following page, a newly created label is displayed on the course page
</code>

Latest revision as of 09:18, 22 May 2019

Problem

Often a bug reporter is a developer or/and an expert Moodle user. By consequence he forgets to add the test steps into the description.

Solution

When you know how to reproduce/test a bug in Moodle, please indicate these test steps. The steps should explain to a Moodle user (not a developer) how to see the problem in Moodle.

The reasons

  • the developer will be happy: the steps are very useful for the developer in order to reproduce/test your issue. Think that sometimes the developer has the ability to fix a bug, but doesn't have yet your knowledge about the module containing this bug.
  • the QA manager will be even more happy: if you indicate the test steps, any QA tester would be able to retest and validate the fix during the weekly quality assurance process.

Example of test steps

Environment: Moodle 2.0 - Server run on Linux/Apache/MySQL

Steps to reproduce: 1. Login as Admin 2. Go to a course page 3. Turn editing on 4. Add a "Label" resource 5. On the following page, enter some arbitrary label text 6. Press the Save button

Actual result: On the following page, the label is not displayed on the course page

Expected result: On the following page, a newly created label is displayed on the course page