Skip to content
kereid edited this page Dec 16, 2013 · 9 revisions

Where Are Issues Tracked?

In case it has not been made clear we track our issues via GitHub here

How Are Issues Created?

Anyone with a GitHub account can create an issue. An issue should be given either a bug label or a enhancement label when it is created.

What is a bug?

A bug is when a feature of the Portal does not behave the way it was designed. When adding an issue which is a bug please add the bug label. Where possible please create the issue with this template:

Steps To Repeat

What I Expected To Happen

What Actually Happened

This format is taken from http://www.joelonsoftware.com/articles/fog0000000029.html. Reporting bugs like this makes it infinitely easier for developers to resolve them. Here are some examples within our issues.

What is an enhancement?

An enhancement is something the Portal can't do at the moment but that you (or someone else) would like it to do. An enhancement might be a request for a new feature, or it might be asking for existing behaviour to be changed. If you are reporting an enhancement please label the issue with the enhancement label.

How Are Issues Handled?

Where possible we attempt to resolve bug issues that existed at the start of an iteration within that iteration, our iterations are generally two weeks long. Issues deemed critical by the Product Owner may be resolved before the end of the iteration via a patch release.

Issues are triaged and potentially relabelled.

If an issue does not have someone assigned to it that does not necessarily mean the issue is not being worked on, we use a different mechanism internally to track who is assigned to an issue. We do, when we remember, update the assigned to field. You can always post a comment against an issue to ask us for its status.

Closing Of Issues

If you are the creator of an issue, or are following it, you will be notified when the issue has been closed. An issue is closed when the developer has finished their work on it. The changes need to be tested and released before they will be seen on a live Portal.

GitHub automatically closes issues that have a commit on the master branch that reference the issue number in the commit title or body, for example text such as Fixes #100, Closes #101 and Fix #102 result in issues being closed by GitHub. Where possible we endeavour not to use comments that result in issues being automatically closed. Again, post a comment against the issue and ask for its status if you have any questions.

The 'wrong repository' Label

Occasionally users may experience an issue with portal and report it but the issue may not actually be within portal code itself. This is because portal integrates with many other systems. If this is the case the issue may be tagged with the wrong repository label for example this list. These issues are still important to portal working effectively and will go through a triage process before being included in an iteration.