Skip to content

Issue Prioritization

Jump to bottom
Dan Macumber edited this page Jan 29, 2015 · 18 revisions

OpenStudio uses github issues to track both bugs and feature requests. Properly labeling github issues is crucial for managing these issues. Please use the following labels to classify OpenStudio issues in github.

Bug Severity

All bugs should be assigned a severity describing the impact of a bug to the end user. The key here is impartiality and objectivity in judging the bug’s severity. Remember that all bugs seem urgent when you first hear about them. However, personal preferences are not a criteria for giving a bug a severity!

  • Blocker - total loss of functionality, file corruption, or crashes
  • Major - major loss of functionality, no workarounds
  • Normal - some loss of functionality under specific circumstances, may or may not have a workaround
  • Minor - minor loss of functionality, easy workaround is present

Feature Request

A feature request is used to label all issues related to missing features. A missing feature which impedes a workflow is a feature request and not a bug report. If a feature was supposedly delivered but does not work properly then that is a bug report.

Component

Each issue should be tagged with the component or components that the bug impacts or that the feature request is for.

  • Code - issue related to the core code base
  • Installer/Platform - issue related to the installer or is platform specific
  • Measures - issue is related to measures
  • OS App - issue is related to the OpenStudio application
  • PAT - issue is related to the Parametric Analysis Tool application
  • ResultsViewer - issue is related to the ResultsViewer application
  • RunManager - issue is related to the RunManager application
  • SketchUp - issue is related to the OpenStudio SketchUp plug-in

In Progress

Apply this label when an issue has been scheduled for work in Pivotal.

Resolution

If the issue is closed but not fixed, label the final resolution and provide a note explaining the rationale.

  • Can't Reproduce - cannot reproduce the bug as reported
  • Duplicate - issue is a duplicate of another issue, add a note to the original issue
  • Won't Fix - issue will not be addressed for some reason, add a note with explanation (the affected component is to be deprecated, etc)
  • Works As Expected - the issue can be duplicated but the behavior is as designed, add a note explaining this

EnergyPlus Issue

If the issue relates to a bug or missing feature in EnergyPlus then apply this label, link to the EnergyPlus issue if it exists.

Low Frequency

If an issue is known to impact only a small number of users then apply the Low Frequency label.

Clone this wiki locally