Bug reporting: Difference between revisions

From MoodleDocs
(Added info about reporting - took from forum #43952)
(redirect edit)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
Moodle developers encourage bug reporting by users.  It is important to be specific in reporting a bug. 
#redirect [[dev:Tracker introduction]]
 
== Report a bug ==
Report a bug at
[http://moodle.org/bugs  Homepage bug tracker].  You will need to log in the first time to report a bug.  Be sure to fill out every box in the initial screen. 
 
== Developer's comments ==
 
"What’s the hardest thing about a bug report?" Most of the time fixing the bug is the easiest part. Usually the hard part is reproducing the bug.  The developer or problem solver needs to see how it is broke to be able to fix it.  And if they can not duplicate the error, then they can not be sure that it is fixed.
 
Good bug reports contain as much detail as possible and are specific. Generalizing and leaping to conclusions in a bug report is not helpful and often incorrect.
 
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 problem solver has no idea of what the person sees and why they reported this bug.  Now there has to be more communication (which is time) to determine what happened.
 
Consider a bug report which says that the descriptions for the specific RSS feed XYZ@abc  shows as garbage characters rather than the expected characters.
 
== General guidlines ==
 
The best bug reports follow this form:
 
#'''What I did'''. With as much specific detail as possible. Including URLs of feeds or URLs of weblogs when appropriate!
#'''What I expected to have happen'''. Again, with detail. You expectation might mean that our instructions need to improve or our interface should be changed.
#What actually happened. (With detail.)
##Screen shots can really help, too—as long as you also use text to explain what’s wrong.
##Crash logs or error reports if something goes wrong. This can be done by turning on "debug" in your Admin configuration page. Debug is useful because it lets the problem solver know what the software was actually doing.
 
In summary "stick with facts and present enough facts so someone else can try to duplicate the problem.
 
 
== See also ==
 
[[Bug tracker]]
 
[http://moodle.org/bugs  Homepage bug tracker]
 
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=43952 How to manipulate Moodle developers] forum discussion
 
 
[[Category:Teacher]]
[[Category:Administrator]]
[[Category:Developer]]
[[Category:Developer tools]]
 
[[es:Sistema de bugs]]

Latest revision as of 13:15, 15 October 2013