Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Tracker introduction: Difference between revisions

From MoodleDocs
(Adding note about language string changes)
m (→‎Reporting an issue: link update)
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The [http://tracker.moodle.org/ Moodle Tracker] is our database for recording and managing all Moodle development issues - bugs (problems with the software), improvements and feature requests.
The [http://tracker.moodle.org/ Moodle Tracker] is our database for recording and managing all Moodle development issues - bugs (problems with the software), improvements and feature requests.
==Creating a tracker account==
You don't need an account to browse and search for issues in the tracker. However, to add a comment or create a new issue, you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] and then login.
Note: Your tracker account is different to your Moodle.org account.


==Searching for an issue==
==Searching for an issue==
Line 7: Line 13:
# Enter a phrase, such as an error message in the 'Quick Search' box at the top right of the page.
# Enter a phrase, such as an error message in the 'Quick Search' box at the top right of the page.
# If the search returns lots of results, click the 'Updated' column heading so that the most recent issues are displayed first.  
# If the search returns lots of results, click the 'Updated' column heading so that the most recent issues are displayed first.  
# To refine your search, click on 'Moodle' as the project in the left column, then click the 'Refresh search' link below. You can then select particular components or versions as appropriate.
# To refine your search, select 'Moodle' as the project and perhaps add Component as another criteria and enter one or more. You can also click the Updated column heading to show most recently updated issues at the top of the search results.


 
See also [[Tracker tips]]
To do anything more than browsing and searching in the tracker, you'll need to [http://tracker.moodle.org/secure/Signup%21default.jspa create a tracker account] and then login.


==Reporting an issue==
==Reporting an issue==


''First check whether the issue has already been reported by searching.''
''First check whether the issue has already been reported by searching (see above).''
* If you find an issue which appears to relate to your issue, feel free to add a comment providing further information.
* If you find an issue which appears to relate to your issue, feel free to add a comment providing further information.
* Otherwise, please report the issue by clicking the 'Create Issue' link at the top right of the page.
* Otherwise, please report the issue by clicking the 'Create Issue' link at the top right of the page.
If you see a message that you can not create an issue unless you vote for or watch an existing open issue, search a tracker for [https://tracker.moodle.org/issues/?jql=project%20%3D%20MDL%20AND%20resolution%20%3D%20Unresolved Unresolved issues], select one that is interesting to you and click either "Watch" or "Vote" link. This is a protection against spam and also encourages reporters to search tracker first.


Language string problems can be corrected using [[:en:AMOS|AMOS]]. In non-English languages, the relevant language pack needs to be edited. For English string changes, edit the [[:en:AMOS#Suggesting_improvements_to_English_language_strings|en_fix]] language pack.
Language string problems can be corrected using [[:en:AMOS|AMOS]]. In non-English languages, the relevant language pack needs to be edited. For English string changes, edit the [[:en:AMOS#Suggesting_improvements_to_English_language_strings|en_fix]] language pack.
Line 22: Line 29:
For new Moodle issues...
For new Moodle issues...
# Select 'Moodle' as the project and an appropriate issue type then click the 'Create' button.
# Select 'Moodle' as the project and an appropriate issue type then click the 'Create' button.
# Complete the form, making sure you include ''FULL STEPS that developers should take to reproduce the problem, as well as information about WHAT YOU EXPECTED and WHAT ACTUALLY HAPPENS for you.'' It's a good idea to check whether you can reproduce the bug on http://demo.moodle.net and if so, you can write in the bug report 'Bug reproduced on demo.moodle.net'.
# Complete the form, making sure you include ''FULL STEPS that developers should take to reproduce the problem, as well as information about WHAT YOU EXPECTED and WHAT ACTUALLY HAPPENS for you.'' It's a good idea to check whether you can reproduce the bug on https://sandbox.moodledemo.net/ and if so, you can write in the bug report 'Bug reproduced on sandbox.moodledemo.net'.
# Click the 'Create' button.
# Click the 'Create' button.
Reporting an issue in the Moodle tracker video:
<mediaplayer>http://www.youtube.com/watch?v=eCmOoGYldkA&feature=youtu.be</mediaplayer>


==Receiving email notification of issue updates==
==Receiving email notification of issue updates==
Line 78: Line 81:


* [[Tracker guide]] for more detailed information on using the tracker
* [[Tracker guide]] for more detailed information on using the tracker
* [[New feature ideas]]
* [[Tracker for Third Party Add-ons]] for simple instructions on use of the tracker with contrib/third party add-ons
* [[Tracker for Third Party Add-ons]] for simple instructions on use of the tracker with contrib/third party add-ons


[[Category:Tracker]]
[[Category:Tracker]]

Revision as of 12:48, 15 October 2019

The Moodle Tracker is our database for recording and managing all Moodle development issues - bugs (problems with the software), improvements and feature requests.

Creating a tracker account

You don't need an account to browse and search for issues in the tracker. However, to add a comment or create a new issue, you'll need to create a tracker account and then login.

Note: Your tracker account is different to your Moodle.org account.

Searching for an issue

Before creating a new issue, please try searching to check whether it has been reported previously.

  1. Enter a phrase, such as an error message in the 'Quick Search' box at the top right of the page.
  2. If the search returns lots of results, click the 'Updated' column heading so that the most recent issues are displayed first.
  3. To refine your search, select 'Moodle' as the project and perhaps add Component as another criteria and enter one or more. You can also click the Updated column heading to show most recently updated issues at the top of the search results.

See also Tracker tips

Reporting an issue

First check whether the issue has already been reported by searching (see above).

  • If you find an issue which appears to relate to your issue, feel free to add a comment providing further information.
  • Otherwise, please report the issue by clicking the 'Create Issue' link at the top right of the page.

If you see a message that you can not create an issue unless you vote for or watch an existing open issue, search a tracker for Unresolved issues, select one that is interesting to you and click either "Watch" or "Vote" link. This is a protection against spam and also encourages reporters to search tracker first.

Language string problems can be corrected using AMOS. In non-English languages, the relevant language pack needs to be edited. For English string changes, edit the en_fix language pack.

For new Moodle issues...

  1. Select 'Moodle' as the project and an appropriate issue type then click the 'Create' button.
  2. Complete the form, making sure you include FULL STEPS that developers should take to reproduce the problem, as well as information about WHAT YOU EXPECTED and WHAT ACTUALLY HAPPENS for you. It's a good idea to check whether you can reproduce the bug on https://sandbox.moodledemo.net/ and if so, you can write in the bug report 'Bug reproduced on sandbox.moodledemo.net'.
  3. Click the 'Create' button.

Receiving email notification of issue updates

To receive email notification of updates to any issue, you can add yourself as a watcher.

  • Click the 'Watch' link on the right of the issue page.

Note: If you report an issue, you will automatically receive email notification of updates, so there is no need to add yourself as a watcher.

Helping determine development priorities

You can help determine Moodle development priorities by voting for issues that you'd most like to see fixed.

  • Click the 'Vote' link on the right of the issue page.

Linking issues

If you come across two duplicate issues, or otherwise related issues, you can help by linking the more recent issue to the older issue.

  1. In the more recent issue, select 'Link' from the 'More Actions' dropdown menu.
  2. Select the reason for linking the issues, fill in the number of the older issue and a comment (optional) then click the 'Link' button.

Other reasons for linking include

  • Linking to an issue which will help resolve another issue
  • Linking to an issue which is blocked by another issue

What makes a good tracker issue?

When you create a tracker issue, you are effectively asking someone to change Moodle for you. The easier you can make it for that someone to understand your problem, the more likely it is they will be able to fix it. Here are some things that can help:

  • Give step-by-step instructions, so someone else can follow along on their Moodle site and see exactly what you are talking about.
  • If there is an error message (can you turn on debugging?) copy and paste the full text of the error message.
  • Clearly separate fact from speculation in what you write.
  • A picture can be worth a thousand words. Consider taking a screen-grab of the problem.
  • One report one bug / feature request per issue.
  • Remember to search to see if the issue you are reporting is already there. If it is, vote or comment instead.

If you would like to read more about this, the Mozilla bug writing guidelines are good.

Here are good examples of bug reports: MDL-5688, MDL-33532, MDL-34440, MDL-33514, MDL-34475 - notice how quickly all of these got fixed!

What can I do if a problem remains, despite the tracker issue being closed as fixed?

If you find that a bug is still affecting a stable version of Moodle, despite the tracker issue being closed as fixed, please do as follows:

  1. Create a new issue for the bug
  2. Go back to the closed issue and link it to the issue you've just created. This will generate an email notification to all watchers, so they know to watch, vote or comment on the new issue from then on.

See also