| |
home · report a bug
report a bug
If you find a bug while surfing through this website, we would appreciate it if you would report it, using Trac, the official icommons.org bug tracker based on Edgewall software.
Follow these steps to create a good bug report in Trac:
1. Begin by verifying that you have a new bug that is appropriate to report. You can do this by searching for your bug or feature request in Trac by using the Search or Query functions.
• If your issue has already been reported, please do not report a duplicate bug. If you have further information to contribute, log in and add a note to the existing bug.
• If your issue is similar, but not quite the same as another issue, you may decide whether to add a note to the similar issue, or report a new one. It can be difficult to decide whether your issue warrants a new submission, but in general if you just have more information to contribute to a current, open issue, simply add a note to that issue. If you have a different enough issue, or if you are experiencing a recurrence of an issue that was previously resolved, report a new bug.
• If your issue was recently reported and then closed, and you do not agree with the resolution, you can also reopen the ticket and add a comment as to your reasoning.
2. Read this article, linked to from the Wordpress ‘Report a bug’ page, on How to Report Bugs Effectively, and the Trac Ticket documentation.
3. Log into the iCommons Trac system by registering and creating a username and password. This is essential for communication about your bug, since the developers may need more information (and you cannot create a ticket without logging in).
4. Click New Ticket in Trac to navigate to the page where you can report the bug.
5. Fill in the following fields on the new ticket page:
• Short Summary
Make the summary short but informative and accurate, as this is the ticket title that will be displayed in search results.
• Type
Choose whether this bug is a defect, enhancement or task.
• Full Description
Fill in a full description of your bug or feature request. Include a description of the problem, steps someone else would have to take to reproduce the problem, maybe an example of the bug in action (i.e. a URL), and a description of why it is a problem worthy of being corrected. Also include information about your platform, such as operating system, browser version, default language, as well as your username in icommons.org (preferrably as a link to your profile). The better your description, the better the chances of having the bug resolved promptly.
Ticket Properties
• Priority
You will need to decide on a priority for the issue -- this is how urgent the bug is. Unless it is a critical bug, this is best left to the default as developers will usually rank the bug's priority.
• Component
Select the section of icommons.org where the bug was found.
• Severity
The significance of the issue. Select a severity based on how critical you consider the issue to be. If in doubt, leave this option as Normal.
• Assign to
If you know of the developer who is responsible for the code that the bug is in, place their Trac username here, otherwise leave this space empty.
• Milestone
By what version this issue should be resolved, at the latest. Do not change this. This is an option that icommons.org developers will set.
• Keywords
Keywords that will make it easier for developers to find the bug, and identify the areas it affects. An example might be 'uploading' for a bug involving the uploading mechanism in the Culture Database section of icommons.org.
• CC
Who bug information and updates should be sent to. If you want to be kept informed, enter your own Trac user name here. You will then be notified by email any time a change is made to this report, or a note to the bug is added. Don't ignore these emails; any time a change is made, be sure to check the report for updates. Developers may need further information from you, and this is their only way of getting in contact with you. Note: you need to go to the Trac Settings page to set your email address.
6. Click Submit Ticket (after previewing it). Your input is greatly appreciated.
Exception: If you believe that there may be a security bug exposing iCommons.org and the data on the site, to some risk, please email jc@icommons.org directly.
This text is based on the Wordpress ‘Report a bug’ page, the original can be found here.
|
|
|
