Changes between Version 11 and Version 12 of BugReporting

Timestamp:

2013-06-20 19:39:42 (11 years ago)

Author:

jeroens

Comment:

--

BugReporting

@@ -1 +1 @@
 = Bug Report =
-We do our very best to deliver you stable and feature-rich software. Yet, issues may bypass our tests; we're a small team and the software can be used in many different ways. This is the section where you can let us now about behaviour of Ecopath versions 5 and 6 that you think is not correct, and where you can submit suggestions for improvement of the software. In this wiki, any user report is referred to as a 'ticket'. 
+We do our very best to deliver you stable and feature-rich software. Yet, issues may bypass our tests; we're a small team and the software can be used in many different ways. This is the section where you can let us now about behaviour of Ecopath versions 5 and 6 that you think is not correct, and where you can submit suggestions for improvement of the software. In this wiki, any user report is referred to as a 'ticket'.
 
 == Pending tickets ==
-You can find all reported tickets listed [http://sources.ecopath.org/trac/Ecopath/report here]. 
+You can find all reported tickets listed [http://sources.ecopath.org/trac/Ecopath/report here].
 
 == Reporting new tickets ==
-Please [http://sources.ecopath.org/trac/Ecopath/search search the list of open tickets] before you [http://sources.ecopath.org/trac/Ecopath/newticket report a new ticket]; people may have already addressed the same issue. :)
+Please [http://sources.ecopath.org/trac/Ecopath/search search the list of open tickets] before you [http://sources.ecopath.org/trac/Ecopath/newticket report a new ticket]; people may have already addressed the same issue.
 
 === Best practices ===
-This section is due to contain instructions on best practices for reporting tickets. Please sit tight for now.
+Reporting errors via a ticketing system such as Trac is quite a straight-forward process if you stick to a few simple rules. A good bug report ticket needs to have:
+
+ 1. A concise but informative title that explains the essence of the problem
+ 1. A list of steps explaining how to reproduce the bug
+ 1. A sentence explaining what is expected to be seen
+ 1. And lastly, a sentence on what was experienced instead of the expected behaviour
+ 1. Optionally, if the ticket only appears using specific data sets, this data may have to be provided 
+
+An example for a reasonably good bug report is [http://sources.ecopath.org/trac/Ecopath/ticket/1240 ticket #1240].