Difference between revisions of "Bug tracker"

Jump to: navigation, search
Line 1: Line 1:
 
Bug tracking is a very important part of a continous quality control process.  Unlike most proprietary software programs, Moodle bug reporting and bug tracking information is open to everyone.  Moodle's bug tracking sytem is called '''Tracker'''.   
 
Bug tracking is a very important part of a continous quality control process.  Unlike most proprietary software programs, Moodle bug reporting and bug tracking information is open to everyone.  Moodle's bug tracking sytem is called '''Tracker'''.   
  
If you're a new user, please create a new user account [http://tracker.moodle.org here].  This way you can reprot bugs that you find and perhaps participate in discussing and fixing them.
+
If you're a new Tracker user create a new user account [http://tracker.moodle.org here].  This way you can report bugs that you find and perhaps participate in discussing and fixing them.
  
"Bugs" not only includes software problems with current versions of Moodle, but also new ideas, feature requests and even constructive criticism of existing features.
+
"Bugs" not only include software problems with current versions of Moodle, but requests for new features (enhancements), changes in functionality, even constructive criticism of existing features is welcome.
  
 
The beauty of open source is that anyone can participate and help to create a better product for all of us to enjoy. In this project, your input is very welcome!
 
The beauty of open source is that anyone can participate and help to create a better product for all of us to enjoy. In this project, your input is very welcome!

Revision as of 09:22, 23 August 2006

Bug tracking is a very important part of a continous quality control process. Unlike most proprietary software programs, Moodle bug reporting and bug tracking information is open to everyone. Moodle's bug tracking sytem is called Tracker.

If you're a new Tracker user create a new user account here. This way you can report bugs that you find and perhaps participate in discussing and fixing them.

"Bugs" not only include software problems with current versions of Moodle, but requests for new features (enhancements), changes in functionality, even constructive criticism of existing features is welcome.

The beauty of open source is that anyone can participate and help to create a better product for all of us to enjoy. In this project, your input is very welcome!

General guidelines

The best bug reports follow this form:

  1. Steps to reproduce. That is, a detailed sequence of steps a developer can follow to see the problem. It is very hard to fix a bug that is not reproducible. If possible, provide a URL so we can see the problem with one click.
  2. What I expected to happen. Again, provide as much detail as possible. Your expectation might mean that our instructions need to be improved or our interface should be changed.
  3. What actually happened (with detail).

Here is an example of a good bug report, and another.

  • If you have an error message, or information in your PHP or web server logs, copy and paste it into the bug report. If you can, turn on "debug" in your Admin configuration page and reproduce the problem to get the best possible error message.
  • Screen shots are very helpful for some bugs, but please write a textual description of the problem too.
  • Make sure we know everything we need to know about your setup including operating system, database, etc. If in doubt, add more detail in the description. The full set of information that might be relevant is:
    • Server operating system type and version number
    • Web server type and version number
    • PHP version number (and whether you are using an accellerator)
    • Database type and version number
    • Moodle version (this is probably covered by the dropdown at the top of the form.)
    • Client-side operating system type and version number
    • Web browser type and version number

You don't need to give all those details all the time. For example, for a layout rendering problem, you need to give only the client-side OS and browser info, and if it is a server-side problem you only need to describe the setup there. Use your judgement. Here are some examples:

I see this bug with the latest Moodle HEAD running on PHP5.1.2/Apache 2.2.3 on Linux. My database is Postgres 8.1.
This rendering problem happens using Internet Explorer 6.0 on Windows XP.

In summary stick with facts and present enough facts so someone else can duplicate the problem.

Tracking progress of bugs you have reported

You will receive email reports of updates to bugs you report.

Tracking bugs reported by others

You can monitor, or "watch" bugs reported by others. To do this, open the bug, then select "Watch it" from the left hand navigation panel. To add others to the watchlist for your bug, open the bug, select the option "Watching" from the left hand navigation panel. These people will recevie email notification when updates are made to this bug.

Developer comments

"What’s the hardest thing about a bug report?" Most of the time fixing the bug is the easy part, the hard part is reproducing the bug. The developer needs to see how it is broke to be able to fix it. If they can't reproduce the error you can be sure they won't be able to fix it!

Good bug reports contain as much detail as possible and are specific. Don't generalise or leap to conclusions.

For example, a bug report that only says "The RSS feed doesn’t support UTF-8" is not helpful. The developer knows that UTF-8 and RSS feeds are compatible. The developer has no idea of what the person sees and why they reported this bug. In this case more time and effort needs to be expended to determine the problem.

Consider a bug report which says that the descriptions for the specific RSS feed XYZ@abc shows unrecognisable characters rather than expected characters.

See also