Issue Management
All issues (both defects and enhancements) can be filed in qooxdoo's issue tracking system Bugzilla. Before reporting a bug, please search Bugzilla if such a bug has already been reported. This helps to keep the number of duplicate bug entries low.
Quick Steps
Here's a quick How-to to enter a new bug. If you are a first-time reporter, also have a look at the later sections.
- Get an account
If you don't have already, you need to create an account in the issue tracker. - Invoke the New Issue dialogue
- Select the "product"
This means the main category of the issue. Mind that besides categories pertaining to the framework itself, there are others for contributions, the project's web presence, and so forth. Usually, you want framework or something more specific. - Now you are on the main form for entering bug details. Start with clicking on "Hide Advanced Fields". This will make it easier for you to get oriented.
- Select the component
Select the component that matches the area where you observed the issue (e.g. ui-table or tool-generator-config). - Select qooxdoo version
Make sure you select the version of qooxdoo where you observed the issue. - Used browser
Especially if it is a rendering/visual issue, specify the browser model and version you are seeing this issue in. - Summary
Add a one-line summary. Try to be specific (e.g. "'generate.py build' stops with AccessException" rather than "Build broken"). - Add a description
The Description field should contain the following:- A verbal description of the observed issue ("What you see").
- If appropriate, copies of error messages from the console etc. which you are getting.
- A description of the steps to reproduce the issue. Always helpful is code that can be run immediately, like an attached skeleton app or a link to a custom Playground sample.
Guidelines
- Typical bug reports (i.e. obvious defects) should be entered straight into Bugzilla. Please do not post such bug reports to the mailing list. This keeps the mailing list from being cluttered and also allows for a dedicated bug handling.
- Take special care in assigning the proper attributes, e.g. qooxdoo component, browser, operating system, etc.
- There are two attributes that are particularly important to setup and maintain a proper workflow for addressing and fixing the issue: severity and priority. Please do not change these values from their default values, i.e. keep the initial values severity
normaland priorityP3. Those attributes are adjusted during bug triage by the framework maintainers.
- If an issue you have reported is resolved, please verify and adjust the status to verified when appropriate. In case you find the issue is not resolved from your point of view, reopen it and provide a comment clearly stating any remaining issues. See issue handling for more details.
- If you find an existing issue report you are interested in you may add a comment with some additional information and/or add yourself to CC so that you are informed by email about all changes to the bug.
Issues
There are two types of issues, defects and enhancements.
- Defects are typically planned to be fixed in the next release. If it is not possible in the corresponding time frame, defects may be moved to a milestone after the next release.
- All other issues are regarded enhancements, independent of requiring small or large changes. The priority setting is used to order these issues for the next planned milestone. Only enhancements which are actually planned to be released in a reasonable time frame will be assigned. Unassigned enhancements are a "pool" of additional features which contributors are welcome to address.
Patches
When you have successfully resolved a bug or you want to propose an enhancement, you can contribute your code changes as a so-called "patch file". This text file contains the differences between your local version and the official version. The patch file can easily be included with the bug report as an attachment. If you have a Github account, you can create "pull" requests.
Patches should always be made against a current "master" checkout of qooxdoo.
Screenshots
Besides attaching patches to a bug report you can also add a screenshot. Often such a screenshot helps in understanding what the actual problem is. Please make sure the screenshot file is only as large as necessary, so you might want to crop the original image.
Tools
As an alternative to Bugzilla's regular web frontend there are several alternative tools available:
You may use Deskzilla, for which an open-source community license for the host qooxdoo.org has been granted.
Another very powerful tool that helps working in a task-oriented way is the Mylyn plugin for Eclipse IDE.