Module Issues
Accessing Issue Tracker
All development activities for each module hosted on this site are tracked in a unique database. The Issue tracking link on the left navigation bar displays the Issue tracking page, the entry point to that module's issue database. Issue tracking provides the following benefits:
- Ability to chart the progress of individuals and the overall module
- Tracking and maintainance of module history
- Generation and reporting of ongoing to-do lists for all module members.
The different sections appearing in the Issue tracking page indicate the following issue tracking options available to you:
- Query database of issues
- Search module issues by number, keywords, assignee, or other criteria.
- Enter an issue
- Write and commit an issue report to the database.
- My issues
- View a list of module issues assigned to you.
- My preferences
- Configure your Issue Tracker user settings.
- Reports
- Generate and view status reports about issues.
About Issue Tracker
The Issue Tracker used on this site is a variant of BugZilla -- a bug tracking system you may already be familiar with. The Issue Tracker is a more generalized tool for tracking many different kinds of activities in collaborative development modules. Additionally, it does not require a separate login as BugZilla does. The Issue Tracker tool classifies issues into several types:
- Defects (a.k.a. "bugs")
- Enhancements
- Features
- Tasks
- Patches
Each hosted module on this site has it's own, unique issues database. For open source modules in the Issue Tracker, all registered users may query, view, and report issues, while proprietary modules limit access to module members.
Module members have additional permissions within the Issue Tracker to modify and reassign issues, as well as generate reports. Module members are also notified automatically by email whenever issues are assigned to them or there is activity on issues affecting their work.
Entering the tasks you're planning to work on as issues helps you devise and follow a work plan. Because everyone is aware of each module member's area of work, you can avoid duplicating efforts and even help out or offer feedback to other module members. Effective issue tracking requires an understanding of the Issue Tracker tool and a working knowledge of what constitutes a well-written issue report.
In Issue tracker, individual comments have URL anchors. This enables you to point to important moments in a discussion about an issue. For example, when you create an email message or enter an issue comment, you can add a link to a comment in the same or another issue.
To use a comment-specific URL in an issue:
- Click the Modules tab and select a module that uses Issue Tracker.
- Search for an issue that contains several comments (enough so that the entire comment history does not display in the browser window).
- Hover the mouse over one of the comments.
The identity of the comment is displayed in tool tip-like fashion. The tool-tip will display a string, for example, "desc1" or "desc35." Note that not every browser supports this behavior.
- Record the issue number and the tool-tip number, and enter both in an issue comment. For example:
This is a link to a comment in an issue, issue 123, desc23.
- Click Submit.
When you view the issue again, the link will be live. This is true even if it points to a comment in another issue.
To use a comment-specific URL in an email message:
- Click the Modules tab and select a module that uses Issue Tracker.
- Search for an issue that contains several comments (enough so that the entire comment history does not display in the browser window).
- Hover the mouse over one of the comments.
The identity of the comment is displayed in tool tip-like fashion. The tool-tip will display a string, for example, "desc1" or "desc35." Note that not every browser supports this behavior.
- Copy the issue URL from the browser, paste it in the message, and append the following:
#descN
Where N is the number displayed in the tool tip URL. For example, a link to the tenth comment in an issue could resemble the following:
http://module.domain/issues/show_bug.cgi?id=X#desc10
Setting your Issue Tracker user preferences
When you join a module that uses Issue Tracker, you automatically get an Issue Tracker account for access to that module's issues. You can customize this account by editing your user preferences.
To edit your preferences click the My Preferences link on the Issue Tracking page. You have several options to change your user settings:
- Email settings
- Controls your automatic email notification settings. There are two fields for which you can define your preferences on the Email settings tab.
- The Notify me of changes to field allows you define whether you receive email notifications to all issues with which you have some association or only a subset of those issues. The following options are available:
- All qualifying issues: If you select this option, Issue Tracker will send you email notifications of all changes made to all issues you submitted, currently own, have voted on, or are listed in the CC list.
- All qualifying issues except those which I change: If you select this option, Issue Tracker will not send you email notifications when you change an issue, but will send email notifications when any other user changes an issue you submitted, currently own, have voted on, or are listed in the CC list.
- Only those issues which I am listed on the CC line: If you select this option, Issue Tracker will send you email notifications of only changes made to issues for which you are included in the CC list. You will not receive email notifications for issues assigned to you unless you are also in the CC list.
- No email notifications: If you select this option, Issue Tracker will not send you any email notifications of changes made to issues regardless of your association.
- The Users to watch field allows you to receive email notifications of changes made to issues associated with other users. You can use this feature to help you stay informed of the issue activities of a particular use of group of users or to cover for another module member who is temporarily unable to cover his or her own issues. This feature can be a useful mentoring tool if used be a more senior member of a module to stay abreast of the issues assigned to more junior module members.
- Query link settings
- Include/exclude "My issues" or your named, custom queries in every Issue Tracker page footer.
- Permissions
- Displays your issue tracking permissions but cannot be changed because permissions are assigned by the Module Owner. (See next section.)
About issue tracking permissions
Once a user becomes a member of a module, he or she is granted additional Issue Tracker permissions beyond the default database query capabilities. Permissions can be viewed by clicking on the My preferences link on the Issue tracking page, or the My preferences link on the Issues page.
Issue tracking permissions depend upon module role:
- Observers can create and modify issues, but can make changes to only their own issues. Observers have the ability to comment on any issue.
- Developers (code or content) can report and modify their own and other module issues. If they have been granted the "Can edit all aspects of any issue" permission, they have the ability to alter all issue characteristics, including milestones and issue assignments.
- Module initiators automatically are granted administrative level Issue Tracker permissions with additional rights to configure issue tracking for the module. Module initiators can also assign Issue Tracker-specific permissions to other module members.
Additional permissions can be requested through the module owner. You may need to request a new module role.
Permissions affect the lifecycle and resolution of issues. For example, if you have the "Module Issue Tracking - Change" permission, then you can change the status of any UNCONFIRMED issue to NEW . A change in issue status sends an alert to the owner and all other module members associated with the issue.To understand more about issue status, read more about the lifecycle of issues.
More resources about issues and issue tracking
** These links listed are associated with BugZilla, but offer useful bug-writing guidelines that are applicable to the Issue Tracker tool. Be aware that there are differences between the two tools. Parts of BugZilla documentation may not apply or may not address certain features in the Issue Tracker, and vice versa. Because the Issue Tracker is an open source derivative of BugZilla (version 2.11), it is still a work in progress. For those who are interested in more information about this, visit Mozilla.org.
If you are interested in finding out about other bug tracking systems being developed, see the scarab open source module.