HowTo: Writing Bug Reports and Feature Requests

Thursday, February 23 2006 @ 11:26 PM CET
Contributed by: Karsten Thoms

openArchitectureWare uses the Bugtracker System for bug tracking and feature requests. If you have found a bug in the openArchitectureWare software please write a bug report into this system. Do not abuse the forum for bug tracking, because your there is no guarantee that someone feels responsible to solve your problem. The support forum is an informal platform to discuss your problems and has no direct influence on code changes to openArchitectureWare. Further by bug reports we will be able to make more precise change logs for releases, as we can refer to the bug id's.

Please read this article carefully to know how to create a bug report.

Log-in to the Bug System

The Bugtracker System is based on Bugzilla, a simple but effective web-based bug tracking software. To be able to create bug reports you have to create an account. You will have to specify an email address and after creating an account an email will be sent to your address containing your initial password. Of course you can change it in your personal preferences after an initial login.

Create a Bug Report

On the main page there is an entry "Report a new bug". After clicking this link you have to choose the right category for your bug. Add the bug report using these properties:

Product: OAW4
Component: Choose the affected oAW component
Version: Choose the version you are using

Write a brief summary that describes the bug and a detailled description. Please make sure that the bug report is precise enough so that can be easily reproduced. If possible provide a sample project or even better a test and a patch.

Create a Feature Request

Feature Requests are also entered as a bug report. Use the severity category Enhancement to make a Feature Request for openArchitectureWare.

Attachments

Stack traces and logs

Please do not copy stack traces or logs as a bug comment! Make a text file containing your stack trace and make an attachment to the bug.

Use the Create a new Attachment link in the Bug report and enter the file name, the description (e.g. "Stacktrace") and select auto-detect as content type.

Other attachments

Proceed like explained above. Use the "auto-detect" function to determine the content type of your attachment or enter it manually.

What happens with your bug report

After submitting your bug report the bug will have state NEW. In this state the developers will read the bug report and assign it to someone. The state will change to ASSIGNED. The responsible developer will prove the bug report. When the work on the bug is finished it will get the state RESOLVED.

Further information

If you want to know more about this bug tracking system you might read this docs:

HowTo: Writing Bug Reports and Feature Requests | 3 comments | Create New Account

The following comments are owned by whomever posted them. This site is not responsible for what they say.

Authored by: Mac on Monday, March 03 2008 @ 01:35 PM CET

That is cool stuff, I was finding the way to trace that out, now I can apply this easy steps to report a bug or request a feature. Thanks for the Good Note

Regards,
-Sunny
Budget Carrental

Authored by: WhiteApple on Monday, November 15 2010 @ 03:28 PM CET

To tell the truth, I've already downloaded a lot of different articles and tutorials on the subject from different web resources ( http://filecraft.com SE for instance ) and the main conclusion I have come to is that the first rule of a good “bug report” is to call it an “error report”. We should clean up our language by no longer calling a bug a bug but by calling it an error. It is much more honest because it squarely puts the blame where it belongs, viz. with the programmer who made the error. The animistic metaphor of the bug that maliciously sneaked in while the programmer was not looking is intellectually dishonest as it disguises that the error is the programmer’s own creation. The nice thing of this simple change of vocabulary is that it has such a profound effect: while, before, a program with only one bug used to be “almost correct”, afterwards a program with an error is just “wrong” (because in error).

Authored by: open on Tuesday, February 08 2011 @ 02:26 PM CET

I am happy that I bumped into this article. I was totally aware of writing a bug report earlier. I usually ignore whenever a notification for writing a bug report comes. It is very clearly described in this article about the Bugtracker and how to write a bug report. I am really amazed to know about how this report system works. In my opinion, many of us are unaware that writing a bug report can actually resolve the bug that has affected the openArchitectureWare. high availability

oAW has moved to Eclipse.