MoodleDocs - User contributions [en]

User:Julian Ridden

2013-08-13T05:02:12Z

Trogdor: Created page with "* Moodle Evangelist and Theme Guru working for the Australian Moodle Partner [http://www.pukunui.com/au/ Pukunui Australia]"

* Moodle Evangelist and Theme Guru working for the Australian Moodle Partner [http://www.pukunui.com/au/ Pukunui Australia]

Tracker introduction

2013-08-13T04:54:32Z

Trogdor: /* See also */

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.

==Searching for an issue==

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

# 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.
# 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 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==

# ''First check whether the issue has already been reported by searching.''
# 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.
# 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'.
# 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==

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.

# In the more recent issue, select 'Link' from the 'More Actions' dropdown menu.
# 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 [[:en:Debugging|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 [https://developer.mozilla.org/en/Bug_writing_guidelines 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:

# Create a new issue for the bug
# 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==

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

[[Category:Tracker]]

Tracker for Third Party Add-ons

2013-08-13T04:53:57Z

Trogdor:

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. Here they are then assigned to a developer who is best placed to fix them.

What many users don't know is that even developers of third party plugins (like themes, blocks and modules) can also use this tool.

==Aim of this document==

This document outlines how to report Issues with contrib/third party plugins and uses the "Essential" theme by Julian Ridden as a case study.

Before we go any further it is important to define the word '''issue'''. In the context of tracker an issue is not necessarily a problem. It could be either of the following:

# A problem or '''''BUG'''''
# A way of '''''IMPROVEMENT'''''
# A new '''''FEATURE REQUEST'''''

==Searching for any existing Issues==

To search the Tracker for an existing issue can be a little time consuming. But I have made this easy for you. Just click on the URL below to be take to a pre-defined search that will display all issues already logged by the community with this theme.

[https://tracker.moodle.org/issues/?jql=project%20%3D%20%22Add-ons%22%20AND%20component%20%3D%20%22Theme%3A%20Essential%22/ Theme Essential in the tracker]

On this screen you will see a list of existing reported issues and their status. This screen is important because nothing annoys a developer more than having to respond to the same issue 50 times. Please note you do not even have to be logged in to view the existing issues.

'''TIP:''' Keeping your developers happy ensures they want to fix your problems.

[[File:step_3.jpg]]

==Adding to an existing issue==

If you have information that might be relevant to an existing issue or want to add your voice to it then there are three things you can do.

::'''Comment''': You can add your own comment to the issue. This might be additional information, an example of the issue on your site or adding to the debate regarding a movement forward. Your voice is important if the issue impacts you. The comment button is found at the bottom of the page.

::'''Vote''': Is this an issue that has a big impact on you? Voting adds your name to the issue as someone who thinks that this is important. The more votes received the more important the developer knows this issue to be and the higher priority it will receive

::'''Watch''': Nothing to add but want to stay in the loop? Watching an issue will ensure you are emailed automatically with updates to the item.

'''TIP:''' Another feature many miss is that you can also add attachments. Screenshots are especially useful if you are not sure how to express your comments with words.

[[File:step_3_editing.jpg]]

==Creating a new issue==

So you have a new suggestion or bug to file that no-one else has reported yet? Great! Let us know by creating a new issue. Please don't be intimidated by the interface. They are easy and quick to create and if placed here in the Moodle Tracker have a much stronger chance of being seen and actioned.

'''TIP:''' The more information you can put in the better. Using Debug mode in your moodle site is a great way of getting useful information for the developer to action. Screenshots are also a fantastic way of "seeing" your issue and links to your site if the issue is visible can also be highly beneficial.

I have tried to make this as simple as I can in the steps below.

;'''Step 1: Log In'''
: Log into Moodle Tracker using your free Moodle account. This link is at the top of every Moodle Tracker page.
----

;'''Step 2: Create your Issue'''
: Click "Create Issue" form the "Issues" drop down menu.

[[File:step_1.jpg]]
----

;'''Step 3: Identify the project'''
: You will need to choose the appropriate project. Third party code is referred to as Add-ons. As you start typing this in you will be able to select it from the drop down list.

[[File:step_2_project.jpg]]
----

;'''Step 4: What kind of issue is this?'''
: What kind of issue are you reporting? Is this a problem or BUG? A NEW FEATURE you would like added or maybe a simple IMPROVEMENT you would like to see.

[[File:step_2_type.jpg]]
----

;'''Step 5: Be descriptive'''
: This is pretty simple. The more information you can provide us the better we can answer your issue. The summary should make it easily identifiable, the description outlines your issue in as much detail as possible.

'''TIP:''' There is no such thing as too much information in the description. Only not enough!

[[File:step_2_descriptor.jpg]]
----

;'''Step 6: Identify the specific Add-on are you reporting for.'''
: With Third party Add-on's this always starts with the type of plugin you are referring to. In this case study it is a theme. By typing in "theme" you will see a list of themes you can report on. This could just as easily by a block, report or any other Moodle plugin. Once you start typing you can then select the appropriate component from the list.

'''TIP:''' This step is important if you want a fast response. By choosing the correct component you will ensure the right developer receives your submitted issue.

[[File:step_2_component.jpg]]
----

;'''Step 7: Save it'''
: When you are finished hit "create" at the bottom of the screen to save your issue. When you do this the Moodle Tracker will then also email the developer of the Add-on with your request and the ball will start rolling.

== Summary ==

So that is it! Follow these steps and you will be getting what you want while also not driving your friendly neighbourhood developer insane. I can't promise we always fix things as fast as you want. Or that we will always give you the answer you want. But following these steps will ensure it is done the best and fastest way a possible. Of course there is one more great trick.

'''Getting attention for your issue in the forums'''
The Moodle forums here at Moodle.org are built to work alongside the Moodle Tracker. In your forum post you just need to type in the ID of your Issue. For example, when I type in CONTRIB-4499 you will see it is now automatically a clickable link. Use this to raise awareness of your issue. Ask others to COMMENT or maybe try and raise its VOTE count to get it fast tracked.

Please follow these steps and help lower the rate of Forum Fatigued developers living off cans of energy drinks as they slowly go insane.

'''TIP:''' More detailed information om this process can be found in the Moodle Docs via the links below.

==See also==

* [[Tracker introduction]] for more information on the tracker
* [[Tracker guide]] for more detailed information on using the tracker

[[Category:Tracker]]

Tracker for Third Party Add-ons

2013-08-13T04:51:01Z

Trogdor:

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.

Moodle has a great tool for this called the Moodle Tracker ( http://tracker.moodle.org ). This tool allow users of Moodle to log bugs, security issues and new feature requests for the codebase. Here they are then assigned to a developer who is best placed to fix them. What many users don't know is that even developers of third party plugins (like themes, blocks and modules) can also use this tool.

This document outlines how to report Issues with contrib/third party plugins and uses the "Essential" theme by Julian Ridden as a case study.

Before we go further it is important to define the word '''issue'''. In the context of tracker an issue is not necessarily a problem. It could be either of the following:

# A problem or '''''BUG'''''
# A way of '''''IMPROVEMENT'''''
# A new '''''FEATURE REQUEST'''''

==Searching for any existing Issues==

To search the Tracker for an existing issue can be a little time consuming. But I have made this easy for you. Just click on the URL below to be take to a pre-defined search that will display all issues already logged by the community with this theme.

[https://tracker.moodle.org/issues/?jql=project%20%3D%20%22Add-ons%22%20AND%20component%20%3D%20%22Theme%3A%20Essential%22/ Theme Essential in the tracker]

On this screen you will see a list of existing reported issues and their status. This screen is important because nothing annoys a developer more than having to respond to the same issue 50 times. Please note you do not even have to be logged in to view the existing issues.

'''TIP:''' Keeping your developers happy ensures they want to fix your problems.

[[File:step_3.jpg]]

==Adding to an existing issue==

If you have information that might be relevant to an existing issue or want to add your voice to it then there are three things you can do.

::'''Comment''': You can add your own comment to the issue. This might be additional information, an example of the issue on your site or adding to the debate regarding a movement forward. Your voice is important if the issue impacts you. The comment button is found at the bottom of the page.

::'''Vote''': Is this an issue that has a big impact on you? Voting adds your name to the issue as someone who thinks that this is important. The more votes received the more important the developer knows this issue to be and the higher priority it will receive

::'''Watch''': Nothing to add but want to stay in the loop? Watching an issue will ensure you are emailed automatically with updates to the item.

'''TIP:''' Another feature many miss is that you can also add attachments. Screenshots are especially useful if you are not sure how to express your comments with words.

[[File:step_3_editing.jpg]]

==Creating a new issue==

So you have a new suggestion or bug to file that no-one else has reported yet? Great! Let us know by creating a new issue. Please don't be intimidated by the interface. They are easy and quick to create and if placed here in the Moodle Tracker have a much stronger chance of being seen and actioned.

'''TIP:''' The more information you can put in the better. Using Debug mode in your moodle site is a great way of getting useful information for the developer to action. Screenshots are also a fantastic way of "seeing" your issue and links to your site if the issue is visible can also be highly beneficial.

I have tried to make this as simple as I can in the steps below.

;'''Step 1: Log In'''
: Log into Moodle Tracker using your free Moodle account. This link is at the top of every Moodle Tracker page.
----

;'''Step 2: Create your Issue'''
: Click "Create Issue" form the "Issues" drop down menu.

[[File:step_1.jpg]]
----

;'''Step 3: Identify the project'''
: You will need to choose the appropriate project. Third party code is referred to as Add-ons. As you start typing this in you will be able to select it from the drop down list.

[[File:step_2_project.jpg]]
----

;'''Step 4: What kind of issue is this?'''
: What kind of issue are you reporting? Is this a problem or BUG? A NEW FEATURE you would like added or maybe a simple IMPROVEMENT you would like to see.

[[File:step_2_type.jpg]]
----

;'''Step 5: Be descriptive'''
: This is pretty simple. The more information you can provide us the better we can answer your issue. The summary should make it easily identifiable, the description outlines your issue in as much detail as possible.

'''TIP:''' There is no such thing as too much information in the description. Only not enough!

[[File:step_2_descriptor.jpg]]
----

;'''Step 6: Identify the specific Add-on are you reporting for.'''
: With Third party Add-on's this always starts with the type of plugin you are referring to. In this case study it is a theme. By typing in "theme" you will see a list of themes you can report on. This could just as easily by a block, report or any other Moodle plugin. Once you start typing you can then select the appropriate component from the list.

'''TIP:''' This step is important if you want a fast response. By choosing the correct component you will ensure the right developer receives your submitted issue.

[[File:step_2_component.jpg]]
----

;'''Step 7: Save it'''
: When you are finished hit "create" at the bottom of the screen to save your issue. When you do this the Moodle Tracker will then also email the developer of the Add-on with your request and the ball will start rolling.

== Summary ==

So that is it! Follow these steps and you will be getting what you want while also not driving your friendly neighbourhood developer insane. I can't promise we always fix things as fast as you want. Or that we will always give you the answer you want. But following these steps will ensure it is done the best and fastest way a possible. Of course there is one more great trick.

'''Getting attention for your issue in the forums'''
The Moodle forums here at Moodle.org are built to work alongside the Moodle Tracker. In your forum post you just need to type in the ID of your Issue. For example, when I type in CONTRIB-4499 you will see it is now automatically a clickable link. Use this to raise awareness of your issue. Ask others to COMMENT or maybe try and raise its VOTE count to get it fast tracked.

Please follow these steps and help lower the rate of Forum Fatigued developers living off cans of energy drinks as they slowly go insane.

'''TIP:''' More detailed information om this process can be found in the Moodle Docs via the links below.

==See also==

* [[Tracker introduction]] for more information on the tracker
* [[Tracker guide]] for more detailed information on using the tracker

[[Category:Tracker]]

Tracker for Third Party Add-ons

2013-08-13T04:45:07Z

Trogdor:

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.

Moodle has a great tool for this called the Moodle Tracker ( http://tracker.moodle.org ). This tool allow users of Moodle to log bugs, security issues and new feature requests for the codebase. Here they are then assigned to a developer who is best placed to fix them. What many users don't know is that even developers of third party plugins (like themes, blocks and modules) can also use this tool.

This document outlines how to report Issues with contrib/third party plugins and uses the "Essential" theme by Julian Ridden as a case study.

Before we go further it is important to define the word "issue". In the context of tracker an issue is not necessarily a problem. It could be either of the following:

# A problem or BUG
# A way of IMPROVEMENT
# A new FEATURE REQUEST

==Searching for any existing Issues==

To search the Tracker for an existing issue can be a little time consuming. But I have made this easy for you. Just click on the URL below to be take to a pre-defined search that will display all issues already logged by the community with this theme.

[https://tracker.moodle.org/issues/?jql=project%20%3D%20%22Add-ons%22%20AND%20component%20%3D%20%22Theme%3A%20Essential%22/ Theme Essential in the tracker]

On this screen you will see a list of existing reported issues and their status. This screen is important because nothing annoys a developer more than having to respond to the same issue 50 times. Please note you do not even have to be logged in to view the existing issues.

TIP: Keeping your developers happy ensures they want to fix your problems.

[[File:step_3.jpg]]

==Adding to an existing issue==

If you have information that might be relevant to an existing issue or want to add your voice to it then there are three things you can do.

Comment: You can add your own comment to the issue. This might be additional information, an example of the issue on your site or adding to the debate regarding a movement forward. Your voice is important if the issue impacts you. The comment button is found at the bottom of the page.

Vote: Is this an issue that has a big impact on you? Voting adds your name to the issue as someone who thinks that this is important. The more votes received the more important the developer knows this issue to be and the higher priority it will receive

Watch: Nothing to add but want to stay in the loop? Watching an issue will ensure you are emailed automatically with updates to the item.

TIP: Another feature many miss is that you can also add attachments. Screenshots are especially useful if you are not sure how to express your comments with words.

[[File:step_3_editing.jpg]]

==Creating a new issue==

So you have a new suggestion or bug to file that no-one else has reported yet? Great! Let us know by creating a new issue. Please don't be intimidated by the interface. They are easy and quick to create and if placed here in the Moodle Tracker have a much stronger chance of being seen and actioned.

Tip: The more information you can put in the better. Using Debug mode in your moodle site is a great way of getting useful information for the developer to action. Screenshots are also a fantastic way of "seeing" your issue and links to your site if the issue is visible can also be highly beneficial.

I have tried to make this as simple as I can in the steps below.

;'''Step 1: Log In'''
: Log into Moodle Tracker using your free Moodle account. This link is at the top of every Moodle Tracker page.
----

;'''Step 2: Create your Issue'''
: Click "Create Issue" form the "Issues" drop down menu.

[[File:step_1.jpg]]
----

;'''Step 3: Identify the project'''
: You will need to choose the appropriate project. Third party code is referred to as Add-ons. As you start typing this in you will be able to select it from the drop down list.

[[File:step_2_project.jpg]]
----

;'''Step 4: What kind of issue is this?'''
: What kind of issue are you reporting? Is this a problem or BUG? A NEW FEATURE you would like added or maybe a simple IMPROVEMENT you would like to see.

[[File:step_2_type.jpg]]
----

;'''Step 5: Be descriptive'''
: This is pretty simple. The more information you can provide us the better we can answer your issue. The summary should make it easily identifiable, the description outlines your issue in as much detail as possible.

TIP: There is no such thing as too much information in the description. Only not enough!

[[File:step_2_descriptor.jpg]]
----

;'''Step 6: Identify the specific Add-on are you reporting for.'''
: With Third party Add-on's this always starts with the type of plugin you are referring to. In this case study it is a theme. By typing in "theme" you will see a list of themes you can report on. This could just as easily by a block, report or any other Moodle plugin. Once you start typing you can then select the appropriate component from the list.

TIP: This step is important if you want a fast response. By choosing the correct component you will ensure the right developer receives your submitted issue.

[[File:step_2_component.jpg]]
----

;'''Step 7: Save it'''
: When you are finished hit "create" at the bottom of the screen to save your issue. When you do this the Moodle Tracker will then also email the developer of the Add-on with your request and the ball will start rolling.

== Summary ==

So that is it! Follow these steps and you will be getting what you want while also not driving your friendly neighbourhood developer insane. I can't promise we always fix things as fast as you want. Or that we will always give you the answer you want. But following these steps will ensure it is done the best and fastest way a possible. Of course there is one more great trick.

'''Getting attention for your issue in the forums'''
The Moodle forums here at Moodle.org are built to work alongside the Moodle Tracker. In your forum post you just need to type in the ID of your Issue. For example, when I type in CONTRIB-4499 you will see it is now automatically a clickable link. Use this to raise awareness of your issue. Ask others to COMMENT or maybe try and raise its VOTE count to get it fast tracked.

Please follow these steps and help lower the rate of Forum Fatigued developers living off cans of energy drinks as they slowly go insane.

TIP: More detailed information om this process can be found in the Moodle Docs here: https://docs.moodle.org/dev/Tracker_introduction

==See also==

* [[Tracker introduction]] for more information on the tracker
* [[Tracker guide]] for more detailed information on using the tracker

[[Category:Tracker]]

Tracker for Third Party Add-ons

2013-08-13T04:44:18Z

Trogdor:

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.

Moodle has a great tool for this called the Moodle Tracker ( http://tracker.moodle.org ). This tool allow users of Moodle to log bugs, security issues and new feature requests for the codebase. Here they are then assigned to a developer who is best placed to fix them. What many users don't know is that even developers of third party plugins (like themes, blocks and modules) can also use this tool.

This document outlines how to report Issues with contrib/third party plugins and uses the "Essential" theme by Julian Ridden as a case study.

Before we go further it is important to define the word "issue". In the context of tracker an issue is not necessarily a problem. It could be either of the following:

# A problem or BUG
# A way of IMPROVEMENT
# A new FEATURE REQUEST

==Searching for any existing Issues==

To search the Tracker for an existing issue can be a little time consuming. But I have made this easy for you. Just click on the URL below to be take to a pre-defined search that will display all issues already logged by the community with this theme.

[https://tracker.moodle.org/issues/?jql=project%20%3D%20%22Add-ons%22%20AND%20component%20%3D%20%22Theme%3A%20Essential%22/ Theme Essential in the tracker]

On this screen you will see a list of existing reported issues and their status. This screen is important because nothing annoys a developer more than having to respond to the same issue 50 times. Please note you do not even have to be logged in to view the existing issues.

TIP: Keeping your developers happy ensures they want to fix your problems.

[[File:step_3.jpg]]

==Adding to an existing issue==

If you have information that might be relevant to an existing issue or want to add your voice to it then there are three things you can do.

Comment: You can add your own comment to the issue. This might be additional information, an example of the issue on your site or adding to the debate regarding a movement forward. Your voice is important if the issue impacts you. The comment button is found at the bottom of the page.

Vote: Is this an issue that has a big impact on you? Voting adds your name to the issue as someone who thinks that this is important. The more votes received the more important the developer knows this issue to be and the higher priority it will receive

Watch: Nothing to add but want to stay in the loop? Watching an issue will ensure you are emailed automatically with updates to the item.

TIP: Another feature many miss is that you can also add attachments. Screenshots are especially useful if you are not sure how to express your comments with words.

[[File:step_3_editing.jpg]]

==Creating a new issue==

So you have a new suggestion or bug to file that no-one else has reported yet? Great! Let us know by creating a new issue. Please don't be intimidated by the interface. They are easy and quick to create and if placed here in the Moodle Tracker have a much stronger chance of being seen and actioned.

Tip: The more information you can put in the better. Using Debug mode in your moodle site is a great way of getting useful information for the developer to action. Screenshots are also a fantastic way of "seeing" your issue and links to your site if the issue is visible can also be highly beneficial.

I have tried to make this as simple as I can in the steps below.

;'''Step 1: Log In'''
: Log into Moodle Tracker using your free Moodle account. This link is at the top of every Moodle Tracker page.
----

;'''Step 2: Create your Issue'''
: Click "Create Issue" form the "Issues" drop down menu.

[[File:step_1.jpg]]
----

;'''Step 3: Identify the project'''
: You will need to choose the appropriate project. Third party code is referred to as Add-ons. As you start typing this in you will be able to select it from the drop down list.

[[File:step_2_project.jpg]]
----

;'''Step 4: What kind of issue is this?'''
: What kind of issue are you reporting? Is this a problem or BUG? A NEW FEATURE you would like added or maybe a simple IMPROVEMENT you would like to see.

[[File:step_2_type.jpg]]
----

;'''Step 5: Be descriptive'''
: This is pretty simple. The more information you can provide us the better we can answer your issue. The summary should make it easily identifiable, the description outlines your issue in as much detail as possible.

TIP: There is no such thing as too much information in the description. Only not enough!

[[File:step_2_descriptor.jpg]]
----

;'''Step 6: Identify the specific Add-on are you reporting for.'''
: With Third party Add-on's this always starts with the type of plugin you are referring to. In this case study it is a theme. By typing in "theme" you will see a list of themes you can report on. This could just as easily by a block, report or any other Moodle plugin. Once you start typing you can then select the appropriate component from the list.

TIP: This step is important if you want a fast response. By choosing the correct component you will ensure the right developer receives your submitted issue.

[[File:step_2_component.jpg]]
----

Step 7: Save it
: When you are finished hit "create" at the bottom of the screen to save your issue. When you do this the Moodle Tracker will then also email the developer of the Add-on with your request and the ball will start rolling.

== Summary ==

So that is it! Follow these steps and you will be getting what you want while also not driving your friendly neighbourhood developer insane. I can't promise we always fix things as fast as you want. Or that we will always give you the answer you want. But following these steps will ensure it is done the best and fastest way a possible. Of course there is one more great trick.

'''Getting attention for your issue in the forums'''
The Moodle forums here at Moodle.org are built to work alongside the Moodle Tracker. In your forum post you just need to type in the ID of your Issue. For example, when I type in CONTRIB-4499 you will see it is now automatically a clickable link. Use this to raise awareness of your issue. Ask others to COMMENT or maybe try and raise its VOTE count to get it fast tracked.

Please follow these steps and help lower the rate of Forum Fatigued developers living off cans of energy drinks as they slowly go insane.

TIP: More detailed information om this process can be found in the Moodle Docs here: https://docs.moodle.org/dev/Tracker_introduction

==See also==

* [[Tracker introduction]] for more information on the tracker
* [[Tracker guide]] for more detailed information on using the tracker

[[Category:Tracker]]

Tracker for Third Party Add-ons

2013-08-13T04:42:44Z

Trogdor:

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.

Moodle has a great tool for this called the Moodle Tracker ( http://tracker.moodle.org ). This tool allow users of Moodle to log bugs, security issues and new feature requests for the codebase. Here they are then assigned to a developer who is best placed to fix them. What many users don't know is that even developers of third party plugins (like themes, blocks and modules) can also use this tool.

This document outlines how to report Issues with contrib/third party plugins and uses the "Essential" theme by Julian Ridden as a case study.

Before we go further it is important to define the word "issue". In the context of tracker an issue is not necessarily a problem. It could be either of the following:

# A problem or BUG
# A way of IMPROVEMENT
# A new FEATURE REQUEST

==Searching for any existing Issues==

To search the Tracker for an existing issue can be a little time consuming. But I have made this easy for you. Just click on the URL below to be take to a pre-defined search that will display all issues already logged by the community with this theme.

[https://tracker.moodle.org/issues/?jql=project%20%3D%20%22Add-ons%22%20AND%20component%20%3D%20%22Theme%3A%20Essential%22/ Theme Essential in the tracker]

On this screen you will see a list of existing reported issues and their status. This screen is important because nothing annoys a developer more than having to respond to the same issue 50 times. Please note you do not even have to be logged in to view the existing issues.

TIP: Keeping your developers happy ensures they want to fix your problems.

[[File:step_3.jpg]]

==Adding to an existing issue==

If you have information that might be relevant to an existing issue or want to add your voice to it then there are three things you can do.

Comment: You can add your own comment to the issue. This might be additional information, an example of the issue on your site or adding to the debate regarding a movement forward. Your voice is important if the issue impacts you. The comment button is found at the bottom of the page.

Vote: Is this an issue that has a big impact on you? Voting adds your name to the issue as someone who thinks that this is important. The more votes received the more important the developer knows this issue to be and the higher priority it will receive

Watch: Nothing to add but want to stay in the loop? Watching an issue will ensure you are emailed automatically with updates to the item.

TIP: Another feature many miss is that you can also add attachments. Screenshots are especially useful if you are not sure how to express your comments with words.

[[File:step_3_editing.jpg]]

==Creating a new issue==

So you have a new suggestion or bug to file that no-one else has reported yet? Great! Let us know by creating a new issue. Please don't be intimidated by the interface. They are easy and quick to create and if placed here in the Moodle Tracker have a much stronger chance of being seen and actioned.

Tip: The more information you can put in the better. Using Debug mode in your moodle site is a great way of getting useful information for the developer to action. Screenshots are also a fantastic way of "seeing" your issue and links to your site if the issue is visible can also be highly beneficial.

I have tried to make this as simple as I can in the steps below.

;'''Step 1: Log In'''
: Log into Moodle Tracker using your free Moodle account. This link is at the top of every Moodle Tracker page.

;'''Step 2: Create your Issue'''
: Click "Create Issue" form the "Issues" drop down menu.

[[File:step_1.jpg]]

;'''Step 3: Identify the project'''
: You will need to choose the appropriate project. Third party code is referred to as Add-ons. As you start typing this in you will be able to select it from the drop down list.

[[File:step_2_project.jpg]]

;'''Step 4: What kind of issue is this?'''
: What kind of issue are you reporting? Is this a problem or BUG? A NEW FEATURE you would like added or maybe a simple IMPROVEMENT you would like to see.

[[File:step_2_type.jpg]]

;'''Step 5: Be descriptive'''
: This is pretty simple. The more information you can provide us the better we can answer your issue. The summary should make it easily identifiable, the description outlines your issue in as much detail as possible.

TIP: There is no such thing as too much information in the description. Only not enough!

[[File:step_2_descriptor.jpg]]

;'''Step 6: Identify the specific Add-on are you reporting for.'''
: With Third party Add-on's this always starts with the type of plugin you are referring to. In this case study it is a theme. By typing in "theme" you will see a list of themes you can report on. This could just as easily by a block, report or any other Moodle plugin. Once you start typing you can then select the appropriate component from the list.

TIP: This step is important if you want a fast response. By choosing the correct component you will ensure the right developer receives your submitted issue.

[[File:step_2_component.jpg]]

Step 7: Save it
: When you are finished hit "create" at the bottom of the screen to save your issue. When you do this the Moodle Tracker will then also email the developer of the Add-on with your request and the ball will start rolling.

== Summary ==

So that is it! Follow these steps and you will be getting what you want while also not driving your friendly neighbourhood developer insane. I can't promise we always fix things as fast as you want. Or that we will always give you the answer you want. But following these steps will ensure it is done the best and fastest way a possible. Of course there is one more great trick.

'''Getting attention for your issue in the forums'''
The Moodle forums here at Moodle.org are built to work alongside the Moodle Tracker. In your forum post you just need to type in the ID of your Issue. For example, when I type in CONTRIB-4499 you will see it is now automatically a clickable link. Use this to raise awareness of your issue. Ask others to COMMENT or maybe try and raise its VOTE count to get it fast tracked.

Please follow these steps and help lower the rate of Forum Fatigued developers living off cans of energy drinks as they slowly go insane.

TIP: More detailed information om this process can be found in the Moodle Docs here: https://docs.moodle.org/dev/Tracker_introduction

==See also==

* [[Tracker introduction]] for more information on the tracker
* [[Tracker guide]] for more detailed information on using the tracker

[[Category:Tracker]]

File:step 2 component.jpg

2013-08-13T04:37:38Z

Trogdor:

File:step 2 descriptor.jpg

2013-08-13T04:37:30Z

Trogdor:

File:step 2 type.jpg

2013-08-13T04:37:22Z

Trogdor:

File:step 2 project.jpg

2013-08-13T04:37:16Z

Trogdor:

File:step 1.jpg

2013-08-13T04:37:09Z

Trogdor:

File:step 3 editing.jpg

2013-08-13T04:37:01Z

Trogdor:

File:step 3.jpg

2013-08-13T04:36:13Z

Trogdor:

Tracker for Third Party Add-ons

2013-08-13T04:35:21Z

Trogdor: This document outlines how to report Issues with contrib/third party plugins and uses the "Essential" theme by Julian Ridden as a case study.

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.

Moodle has a great tool for this called the Moodle Tracker ( http://tracker.moodle.org ). This tool allow users of Moodle to log bugs, security issues and new feature requests for the codebase. Here they are then assigned to a developer who is best placed to fix them. What many users don't know is that even developers of third party plugins (like themes, blocks and modules) can also use this tool.

This document outlines how to report Issues with contrib/third party plugins and uses the "Essential" theme by Julian Ridden as a case study.

Before we go further it is important to define the word "issue". In the context of tracker an issue is not necessarily a problem. It could be either of the following:

# A problem or BUG
# A way of IMPROVEMENT
# A new FEATURE REQUEST

==Searching for any existing Issues==

To search the Tracker for an existing issue can be a little time consuming. But I have made this easy for you. Just click on the URL below to be take to a pre-defined search that will display all issues already logged by the community with this theme.

[http://tinyurl.com/Tracker-Essential]

On this screen you will see a list of existing reported issues and their status. This screen is important because nothing annoys a developer more than having to respond to the same issue 50 times. Please note you do not even have to be logged in to view the existing issues.

TIP: Keeping your developers happy ensures they want to fix your problems.

[[File:step_3.jpg]]

==Adding to an existing issue==

If you have information that might be relevant to an existing issue or want to add your voice to it then there are three things you can do.

Comment: You can add your own comment to the issue. This might be additional information, an example of the issue on your site or adding to the debate regarding a movement forward. Your voice is important if the issue impacts you. The comment button is found at the bottom of the page.

Vote: Is this an issue that has a big impact on you? Voting adds your name to the issue as someone who thinks that this is important. The more votes received the more important the developer knows this issue to be and the higher priority it will receive

Watch: Nothing to add but want to stay in the loop? Watching an issue will ensure you are emailed automatically with updates to the item.

TIP: Another feature many miss is that you can also add attachments. Screenshots are especially useful if you are not sure how to express your comments with words.

[[File:step_3_editing.jpg]]

==Creating a new issue==

So you have a new suggestion or bug to file that no-one else has reported yet? Great! Let us know by creating a new issue. Please don't be intimidated by the interface. They are easy and quick to create and if placed here in the Moodle Tracker have a much stronger chance of being seen and actioned.

Tip: The more information you can put in the better. Using Debug mode in your moodle site is a great way of getting useful information for the developer to action. Screenshots are also a fantastic way of "seeing" your issue and links to your site if the issue is visible can also be highly beneficial.

I have tried to make this as simple as I can in the steps below.

'''Step 1: Log In'''
Log into Moodle Tracker using your free Moodle account. This link is at the top of every Moodle Tracker page.

'''Step 2: Create your Issue'''
Click "Create Issue" form the "Issues" drop down menu.

[[File:step_1.jpg]]

'''Step 3: Identify the project'''
You will need to choose the appropriate project. Third party code is referred to as Add-ons. As you start typing this in you will be able to select it from the drop down list.

[[File:step_2_project.jpg]]

'''Step 4: What kind of issue is this?'''
What kind of issue are you reporting? Is this a problem or BUG? A NEW FEATURE you would like added or maybe a simple IMPROVEMENT you would like to see.

[[File:step_2_type.jpg]]

'''Step 5: Be descriptive'''
This is pretty simple. The more information you can provide us the better we can answer your issue. The summary should make it easily identifiable, the description outlines your issue in as much detail as possible.

TIP: There is no such thing as too much information in the description. Only not enough!

[[File:step_2_descriptor.jpg]]

'''Step 6: Identify the specific Add-on are you reporting for.'''
With Third party Add-on's this always starts with the type of plugin you are referring to. In this case study it is a theme. By typing in "theme" you will see a list of themes you can report on. This could just as easily by a block, report or any other Moodle plugin. Once you start typing you can then select the appropriate component from the list.

TIP: This step is important if you want a fast response. By choosing the correct component you will ensure the right developer receives your submitted issue.

[[File:step_2_component.jpg]]

Step 7: Save it
When you are finished hit "create" at the bottom of the screen to save your issue. When you do this the Moodle Tracker will then also email the developer of the Add-on with your request and the ball will start rolling.

== Summary ==

So that is it! Follow these steps and you will be getting what you want while also not driving your friendly neighbourhood developer insane. I can't promise we always fix things as fast as you want. Or that we will always give you the answer you want. But following these steps will ensure it is done the best and fastest way a possible. Of course there is one more great trick.

'''Getting attention for your issue in the forums'''
The Moodle forums here at Moodle.org are built to work alongside the Moodle Tracker. In your forum post you just need to type in the ID of your Issue. For example, when I type in CONTRIB-4499 you will see it is now automatically a clickable link. Use this to raise awareness of your issue. Ask others to COMMENT or maybe try and raise its VOTE count to get it fast tracked.

Please follow these steps and help lower the rate of Forum Fatigued developers living off cans of energy drinks as they slowly go insane.

TIP: More detailed information om this process can be found in the Moodle Docs here: https://docs.moodle.org/dev/Tracker_introduction

==See also==

* [[Tracker introduction]] for more information on the tracker
* [[Tracker guide]] for more detailed information on using the tracker

[[Category:Tracker]]

Tracker introduction

2013-08-13T04:20:52Z

Trogdor: /* See also */

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.

==Searching for an issue==

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

# 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.
# 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 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==

# ''First check whether the issue has already been reported by searching.''
# 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.
# 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'.
# 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==

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.

# In the more recent issue, select 'Link' from the 'More Actions' dropdown menu.
# 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 [[:en:Debugging|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 [https://developer.mozilla.org/en/Bug_writing_guidelines 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:

# Create a new issue for the bug
# 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==

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

[[Category:Tracker]]