|
|
| (One intermediate revision by the same user not shown) |
| Line 1: |
Line 1: |
| [[File:Buggie.svg|right|200px|All your bug are belong to me!]]
| | Bugzilla is no longer being used to report bugs in the WeBWorK software, but can still be used to report bugs in problems from the [[Open Problem Library]]. |
| | |
| All bugs in the WeBWorK software should be reported at http://bugs.webwork.maa.org. This is also the place to request new features or enhancements to the software.
| |
| | |
| == What is Bugzilla? ==
| |
| | |
| ''For more information, see [[wp:Bugzilla|the Wikipedia article on Bugzilla]].''
| |
| | |
| Bugzilla is an on-line bug-tracking tool, developed by the [http://www.bugzilla.org/ Mozilla Foundation], and is the system we use to track all open issues with WeBWorK.
| |
| | |
| The reason we use Bugzilla is that it allows the developers to easily find, track and discuss issues, to spot duplicates and ultimately to resolve them.
| |
|
| |
|
| == Reporting a bug == | | == Reporting a bug == |
|
| |
|
| # Go to bugs.webwork.maa.org.
| | * If you find a bug in the WeBWorK software, you should report it at https://github.com/openwebwork/webwork2/issues. |
| # Use the search box on the main page to see if your bug has already been submitted. You can also perform more advanced searches on the [http://bugs.webwork.maa.org/query.cgi search page].
| | * If you find a bug with the PG language (the software that renders and checks problems within WeBWorK), you should report it at https://github.com/openwebwork/pg/issues. Note that this is only for issues that affect how problems are parsed. Issues with individual problems in the Open Problem Library should be reported at https://bugs.webwork.maa.org/ |
| # If you are sure that your issue has not already been reported then click [http://bugs.webwork.maa.org/enter_bug.cgi enter a new bug]] in the toolbox on the left. You will be prompted to log in if you have not already done so (see '[[#Why must I register?|Why must I register?]]', below).
| |
| # Select the subsystem of WeBWorK on which you are reporting the bug. (Called a "Product" in Bugzilla)
| |
| # Fill in the following boxes (the rest can be left blank):
| |
| #* Component (if you don't know, select 'General/Unknown')
| |
| #* Version (if you don't know, select 'unspecified')
| |
| #* Summary - a short one-sentence summary of the issue
| |
| #* Description - full details of the issue, giving as much detail as possible
| |
| # Click 'Commit'
| |
| | |
| That's it! For maximum chance of your bug being fixed, you are advised to read the [http://bugs.webwork.maa.org/page.cgi?id=bug-writing.html bug writing guidelines] first.
| |
| | |
| '''''See also:''' [http://www.chiark.greenend.org.uk/~sgtatham/bugs.html How to Report Bugs Effectively] by Simon Tatham''
| |
| | |
| == What syntax can I use? ==
| |
| Bugzilla comments are plain text, you cannot use HTML. However, Bugzilla will automatically make hyperlinks for certain type of text in comments:
| |
| | |
| * most types of URL, e.g. http://bugs.webwork.maa.org
| |
| * bug 12345
| |
| * comment 7
| |
| * bug 23456, comment 53
| |
| * attachment 4321
| |
| * r12345 - link to a revision in [[Subversion]] ([[Special:Code/system]])
| |
| | |
| == Why must I register? ==
| |
| | |
| We need you to register in order to use Bugzilla. This is primarily so that we can contact you if there are further questions regarding your bug submission. For example, if a developer is unable to replicate your problem they will ask for more information.
| |
| | |
| Registering is free and easy. Simply click the 'create account' link at the top right of the page, enter your e-mail address (and optionally your real name) and click 'create account'. Then simply log in using the password you receive in the confirmation e-mail (which can be changed in your preferences once you have logged in).
| |
| | |
| Once logged in, you can change your preferences to specify what kinds of e-mail Bugzilla sends you (with the option of turning off all e-mail). To do this click 'my preferences' in the top right and select the 'email settings' tab.
| |
| | |
| Please note that your email address will be visible to everyone. Some people prefer to set up a separate e-mail account (using a free webmail service) for working with Bugzilla.
| |
| | |
| == Why can't I report bugs here? ==
| |
| | |
| You can. You can also report by writing them in chalk on the pavement. However, if you want a developer to act on it then you need to put it somewhere they are likely to see it, namely Bugzilla.
| |
| | |
| == How do I link to a bug? ==
| |
| | |
| If you want to create a link from a page on this wiki to a Bugzilla bug, use <code><nowiki>[[bugzilla:XXX]]</nowiki></code>, where XXX is the bug number you want to link to. For example <code><nowiki>[[bugzilla:1690]]</nowiki></code> will result in the following output: [[bugzilla:1690]].
| |
| | |
| == See also ==
| |
| * [[Bugzilla products and components]] - finding the right product/component when filing a bug report.
| |
| * [[Bugzilla fields]] - how to fill out different fields in a bug report
| |
| * [http://bugs.webwork.maa.org/page.cgi?id=fields.html#status A bug's life cycle] - how the '''Status''' and '''Resolution''' fields should work.
| |
| * [http://webwork.maa.org/moodle/mod/forum/discuss.php?d=2420 Forum post on Deskzilla] - a desktop Bugzilla client.
| |
|
| |
|
| [[Category:Bugzilla|*Bugzilla]] | | [[Category:Bugzilla|*Bugzilla]] |
| [[Category:Developers]] | | [[Category:Developers]] |