BugClassification.wiki
author Wuzzy <almikes@aol.com>
Tue, 11 Sep 2018 20:10:26 +0200
changeset 1546 3a9e63902b79
child 1547 4bc67d4f7e0d
permissions -rw-r--r--
Add bug classification
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     1
#summary Classification of bugs
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     2
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     3
We classiy [https://issues.hedgewars.org/describecomponents.cgi?product=Hedgewars bugs in Hedgewars] by 1) severity and 2) priority.
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     4
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     5
Severity tells us how much a bug “breaks Hedgewars”.
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     6
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     7
Priority is less important and is just a rough estimate how “important” a bug is within a severity class.
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     8
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     9
== Severity ==
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    10
Severity tells us how much “damage” this bug deals to Hedgewars. The higher the severity of a bug, the more it “breaks” Hedgewars. High-serverity bugs are usually also more important and those should usually get more attention as well.
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    11
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    12
=== Summary ===
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    13
Summary of bug severities:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    14
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    15
 * *Blocker*: Most serious bugs. Must be fixed before next release
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    16
 * *Critical*: Crashes and and similar show-stoppers
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    17
 * *Major*: A key feature is broken or game quality is lowered significantly
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    18
 * *Normal*: Less-important feature is kinda broken
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    19
 * *Minor*: Somethng is slightly irritating or weird
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    20
 * *Trivial*: Nitpicking
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    21
 * *Enhancement*: Feature request (not a bug)
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    22
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    23
=== Blocker ===
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    24
Anything which must be fixed before release. Including:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    25
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    26
 * Hedgewars does not work at all on one of the main platforms
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    27
 * Very obvious crashes
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    28
 * Half-finished feature (either finish it or drop it before release)
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    29
 * Important build script broken
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    30
 * Regression (a bug that did not exist in the previous release)
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    31
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    32
=== Crticial ===
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    33
Any crash, network desynchronization bugs or other bugs that stop the game completely. The most serious bugs of this kind should be classified as blocker.
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    34
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    35
=== Major ===
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    36
A major feature of Hedgewars is obviously broken which lowers the quality notably. The game is still playable as a whole. Including:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    37
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    38
 * Any game-breaking bug. A key aspect of gameplay is broken in an important way, including weapon behaviour. Seriously affects balancing
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    39
 * A weapon or utility is seriously broken, no real workaround
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    40
 * Sound does not work
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    41
 * Obvious and/or annoyingly broken graphics
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    42
 * Broken video recorder
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    43
 * Very annoying usability failure
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    44
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    45
=== Normal ===
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    46
A less-important feature of Hedgewars is kinda broken. Like:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    47
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    48
 * A gameplay aspect is a bit broken. It might affect gameplay negatively a bit. Workaround might be available
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    49
 * A projectile/object/gear behaves incorrectly, but not in a game-breaking way
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    50
 * Mildly annoying usability failure
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    51
 * Notable but unimportant graphical glitch
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    52
 * Important broken translation
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    53
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    54
=== Minor ===
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    55
Bugs with low impact, including:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    56
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    57
 * Gameplay aspect is a bit weird/confusing, but not broken
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    58
 * Computer player does something stupid
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    59
 * Slightly irritating or low quality graphics and sounds
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    60
 * Minor graphical glitch
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    61
 * Subtly broken translations
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    62
 * Code quality complaints
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    63
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    64
=== Trivial ===
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    65
Anything less important than minor. For nitpickers and perfectionists. Rarely used. For bugs like:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    66
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    67
 * “Oh no! This image is off by 2 pixels!”
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    68
 * Very slightly weird GUI
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    69
 * Typos
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    70
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    71
=== Enhancement ===
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    72
For any feature requests. 
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    73
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    74
== Priority ==
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    75
Priority of bugs is a rough estimate of how common or important the bug is estimated to be within the assigned severity class. Priority is a less important classification than severity and just a rough guideline. Generally the more likely it is to experience the bug, the higher its priority. Priority is optional does not need to be specified, it can always be added later.
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    76
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    77
For enhancements, the priority marks the “desirability” of the feature request. High-priority feature requests should generally be implemented before the lower priority ones.