Skip to content
This repository was archived by the owner on May 9, 2019. It is now read-only.

Issue fixing strategy

Jump to bottom
xaav edited this page Sep 18, 2011 · 16 revisions

When working with issues, the following rules will be used to ensure HelioPanel has minimal bugs.

  • All issues must have the "Bug" or "Feature Request" label applied to them, as specified below (excluding exceptions made below).
  • All bugs will be assigned to the current milestone, regardless of their priority, unless specified below.
  • Work will not begin on the next milestone until the current milestone is completed.
  • All feature requests will be assigned to the next milestone.
  • Issues with three days of inactivity may not be reopened, instead a new issue must be created.
  • Once issues are assigned to a milestone, their milestone cannot be changed.
  • Once a milestone is closed, it cannot be reopened.
  • Issues that cannot be fixed by a change to the source code contained in the repository must:*
    • Have ONLY the website label applied to them (They cannot be classified as a Bug or Feature Request).
    • Not be assigned to any milestone.
  • Issues must have a clear and understandable description so that others can understand what needs to be done.

*This is because website issues cannot be fixed by a commit, so they are not assigned to a milestone so that they do not delay it's release.

Bugs vs Feature Requests

  • A Bug is a feature that previously worked, but does not work anymore.
  • All reported bugs must have a minimum word count of 20.**
  • A Bug will have the red Bug label applied to it.
  • A Feature is about functionality that has never worked before.
  • All reported feature requests must have a minimum word count of 40.**
  • A Feature Request will have the green Feature Request label applied to it.
  • A Feature Request must explain why it is needed.

**Word counts are restricted in order to ensure the issue is descriptive and understandable by others.

Examples

  • Bob noticed that renaming a file no longer works, however it did work yesterday. This issue will be classified as a "Bug" and assigned to the current milestone.
  • Ray notices that a new feature that was supposed to work doesn't, and it's been over three days. This will be classified as a "Feature Request" and assigned to the next milestone.
  • Tom sees a "Feature Request" that was closed yesterday, but notices the issue isn't fixed. The issue will be reopened.
  • Sarah notices that a closed "Bug" that has not been fixed, but it has been five days since the last activity. A new issue will be opened and assigned to the current milestone.
  • Carl finds that a "Bug" supposedly fixed just yesterday has in fact not been fixed at all. The issue will be reopened.

Explanation of labels

The following labels may, but do not have to, be assigned to further classify the issue:

  • Major: The issue cannot be fixed quickly.
  • Minor: The issue can be fixed quickly.
  • Urgent: The issue should be fixed before other issues; this is NOT the same as "Major."

Please note that these labels are opinionated and are not guaranteed to give correct or accurate information about the issue.

Clone this wiki locally