Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current  |   View Page History

Issue Tracker Etiquette

Found a bug?

Welcome to the Zend Framework Wiki!

If you do not have a Zend Framework account, please sign up to take full advantage of our site's features.

Developers who wish to contribute to Zend Framework should read the Zend Framework Contributors Guide for getting started pointers, issue tracker guidelines, coding standards, and more.

If you create an account in the system, you can login, report a new issue, or view existing issues. While viewing an issue, on the bottom left side of the page, click the "Watch it" link to receive notifications about resolution progress. Also, we appreciate your comments, feedback, and help testing and proposing patches.

Has your bug already been reported? Please search for a similar looking bug, before reporting a new bug.

Looking for work

The issue tracker no longer assigns new issues to any particular person, they go to "unassigned" instead. This means that anyone is welcome to pick up an issue and decide to work on it. But when is it the right time to do so? And how do you know anyone else isn't working on it? If everyone follows a few simple rules, it will be clear.

  1. If you wish to work on an issue, make sure you are ready to do so before assigning it to yourself. If you think you might work on it later, add a comment indicating your interest but leave it unassigned so that someone else may be able to work on it sooner. If you really feel you are the one to do the job, then go ahead and assign it to yourself. There is a quick link on the issue viewing page to assign one to you.
  2. Once you begin work on an issue, you can mark it "in progress" so everyone else will stay out of the way while you get the work done. Just click the "Start Progress" link while viewing an issue that is assigned to you and off you go! Everyone can easily view "in progress" issues with a filter or dashboard portlet. When done, you can stop the progress by either resolving the issue or by turning it off with the "Stop Progress" link.
  3. If you are not going to work on an item assigned to you, or self-assigned. Then assign it back to "unassigned" so that others may pick it up.
  4. Always try to assign "Fix Versions" to issues you are working on to give intent if you can. (see: Working with Versions below)
  5. When committing a fix for an issue, follow these instructions to autolink the Subversion commit to the issue.

Working with Versions

  1. Issues can be assigned to versions meaning that you are intending to complete them by that time. Some times the project admins or component leads will place them in a version that they feel they need to be completed by.
  2. Issues are placed in versions via the "Fix Versions" field when editing an issue.
  3. If you place an issue in a version, be sure you are ready to meet the scheduled date.
  4. When picking up an issue to work on that is assigned to a version, be sure you are ready to commit to the scheduled date.
  5. When resolving an issue (as fixed), make sure it has a "Fix Version" set to the current release underway.
  6. All versions should have a target date listed when viewing the roadmap within a project.

I'm a component lead!

  • All component leads get notifications for issues marked for their component. So if you are a component lead, make sure you are listed as such by e-mailing Jayson, Darby, or Gavin. This allows the lead to "hear" what is happening with issues in their area.

Other tips

  • Feel free to comment on other issues to help clarify them, to add thoughts on implementation, and to add other problem cases.
  • You can customize the home page of the issue tracker by setting up your own dashboard. You can have multiple tabs, each with portlets on it, and you can in-place edit the settings and layout by turning "configure" on. This gives you your own helpful customized view.
  • When you find an issue that is a duplicate of another, then use the "Link" action to link it as a duplicate. Then resolve it as a duplicate so that they are linked together and one is no longer open.
  • When you have an issue that is dependent on another, link them using the "link" action as dependencies to make that clear.
Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.