Skip to content
Tommy Fotak edited this page Dec 2, 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. If the issue is considered a bug, please add the bug label. When creating an issue, where possible please report it in the following format to make it easy for the developers to resolve;

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.

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 team 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

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.

If you are the creator of an issue or are following it, you will be notified when the issue has been closed. The issue status being closed does not necessarily mean that the fix is visible in the released portal, only that the fix is currently on the master branch. 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.