Skip to content

Issue Tracker Tag Reference

brendo edited this page Oct 22, 2011 · 1 revision

Tags Reference

We love our Issue Tracker, it's the most knowledge person in our team but it's also like trying to find a needle in the haystack. There are tags, but what do they mean? When should you use one over the other? This reference aims to take the mystery out of the tags and puts everyone on the same page.

0 - Needs Test Case

Used when an issue has been posted, but the author hasn't left steps to reproduce the bug, so it's a bit of a wild goose chase for anyone hoping to help fix the issue. At minimum, bug reports should include the version of Symphony, Apache, MySQL, their OS and a set of reproducible steps to repeat the bug. Screenshots and videos are worth a thousand words and will go a long way in helping fix the issue.

Issues with this tag are of the lowest priority as they can take anywhere from 5 minutes to 5 hours to fix.

1 - Feature Request

Used when an issue is more of a request for a new feature, or an alteration on current behaviour. These issues are open for discussion until slapped with a tag with a higher value. It's always useful to get some background on why this feature request is important to you, and why you think that it's something that the core should provide rather than an extension (or if that's half the problem, it's not possible via the delegates). Symphony is a lean, mean, fighting machine and we like to keep it that way.

2 - Minor

The issue has been confirmed, whether it be bug or feature request, but is considered to be of low priority as it's only a minor inconvenience. Fixing this issue should be relatively simple and not risk breaking backwards compatibility. Unless this issue has been assigned to a user, you are free to take it and complete it!

3 - Nominal

The issue has been confirmed, whether it be bug or feature request, and is a relatively straightforward task. Fixing this issue may improve current behaviour or prevent an annoying bug from happening. Backwards compatibility will not be compromised.

4 - Major

The issue has been confirmed, whether it be bug or feature request, and represents an involved task that requires some knowledge of the Symphony codebase. While not always, fixing this issue may break backwards compatibility on a minor level (issues that can be resolved with the Updater), or will represent a significant improvement in existing behaviour.

Issues of this level will need to be mindful that their changes will not affect extension developers, and if they do, there is a migration path for the current release cycle.

5 - Critical

Fixing this issue/implementing this feature request is an very involved task that requires significant knowledge of the Symphony codebase to complete. It may require refactoring of current components, new classes or significantly changing existing behaviour. These issues will generally have owners and milestones and it is expected that upon completion the changes will be fully documented using PHPDoc/JSDoc.

Critical bugs should be completed for the next release as the bug represents major broken functionality which provides a crippling experience for the majority of users, whilst critical feature requests should be left for major releases (2.x).

Other tags

From time to time, similarly grouped issues will be assigned a tag help show the connection. Usually these tasks all have a common theme and involve the same contributors working towards a common goal (ie. Core Email API, UX-UI). Tagging these issues helps keep a history of changes for this subject and it's recommended that Working Groups be mindful of this.

This is a work in progress -- comments welcome