BugClassification.wiki
author Wuzzy
Sun, 26 May 2019 13:38:05 +0100
changeset 1907 806491e9ef60
parent 1571 94d8cb743e9a
permissions -rw-r--r--
LuaGameplay: Delay of 9999
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1547
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
     1
#summary Classification of bugs in Hedgewars
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
     2
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
     3
= Bug classification =
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     4
1571
94d8cb743e9a BugClassification: fix typo
Wuzzy
parents: 1567
diff changeset
     5
We classify [https://issues.hedgewars.org/describecomponents.cgi?product=Hedgewars bugs in Hedgewars] by 1) severity and 2) priority.
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     6
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     7
Severity tells us how much a bug “breaks Hedgewars”.
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
     8
1548
ecdd14257c79 BugClassification: Edited via web interface
Wuzzy
parents: 1547
diff changeset
     9
Priority is optional, less important and a rough estimate how “important” a bug is within a severity class.
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    10
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    11
== Severity ==
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    12
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
    13
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    14
=== Summary ===
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    15
Summary of bug severities:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    16
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    17
 * *Blocker*: Most serious bugs. Must be fixed before next release
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    18
 * *Critical*: Crashes and and similar show-stoppers
1549
31285daa58b6 BugClassification: fix typos
Wuzzy
parents: 1548
diff changeset
    19
 * *Major*: A key feature is broken; game quality is lowered significantly
1550
5da1bcb5bb17 BugClassification: typos
Wuzzy
parents: 1549
diff changeset
    20
 * *Normal*: Less-important feature is kinda broken; incorrect but not seriously broken behaviour
5da1bcb5bb17 BugClassification: typos
Wuzzy
parents: 1549
diff changeset
    21
 * *Minor*: Something is slightly irritating or weird; minor audiovisual glitches
1554
f72e544ce680 BugClassification: summary of trivial
Wuzzy
parents: 1553
diff changeset
    22
 * *Trivial*: Typos and tiny graphical glitches
1552
32b4ccf780c5 BugClassification: fix moar typoz
Wuzzy
parents: 1551
diff changeset
    23
 * *Enhancement*: Feature requests
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    24
1547
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
    25
=== Detailed description ===
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
    26
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
    27
==== Blocker ====
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    28
Anything which must be fixed before release. Including:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    29
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    30
 * Hedgewars does not work at all on one of the main platforms
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    31
 * Very obvious crashes
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    32
 * Half-finished feature (either finish it or drop it before release)
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    33
 * Important build script broken
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    34
 * Regression (a bug that did not exist in the previous release)
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    35
1547
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
    36
==== Crticial ====
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    37
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
    38
1547
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
    39
==== Major ====
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    40
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
    41
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    42
 * 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
    43
 * A weapon or utility is seriously broken, no real workaround
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    44
 * Sound does not work
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    45
 * Obvious and/or annoyingly broken graphics
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    46
 * Broken video recorder
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    47
 * Very annoying usability failure
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    48
1547
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
    49
==== Normal ====
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    50
A less-important feature of Hedgewars is kinda broken. Like:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    51
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    52
 * 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
    53
 * A projectile/object/gear behaves incorrectly, but not in a game-breaking way
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    54
 * Mildly annoying usability failure
1567
56b186f6de7f BugClassification: normal: add sound glitch
Wuzzy
parents: 1554
diff changeset
    55
 * Notable but unimportant graphical/sound glitch
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    56
 * Important broken translation
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    57
1547
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
    58
==== Minor ====
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    59
Bugs with low impact, including:
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    60
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    61
 * Gameplay aspect is a bit weird/confusing, but not broken
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    62
 * Computer player does something stupid
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    63
 * Slightly irritating or low quality graphics and sounds
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    64
 * Minor graphical glitch
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    65
 * Subtly broken translations
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    66
 * Code quality complaints
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    67
1547
4bc67d4f7e0d BugClassification: fix headers
Wuzzy
parents: 1546
diff changeset
    68
==== Trivial ====
1553
ebd6d085e9c9 BugClassification: simpify trivial
Wuzzy
parents: 1552
diff changeset
    69
Anything less important than minor. For nitpickers and perfectionists. For bugs like:
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    70
1553
ebd6d085e9c9 BugClassification: simpify trivial
Wuzzy
parents: 1552
diff changeset
    71
 * Typos
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    72
 * “Oh no! This image is off by 2 pixels!”
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    73
 * Very slightly weird GUI
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    74
1551
f8465989942e BugClassification: fix enhancement header
Wuzzy
parents: 1550
diff changeset
    75
==== Enhancement ====
1552
32b4ccf780c5 BugClassification: fix moar typoz
Wuzzy
parents: 1551
diff changeset
    76
For any feature requests (not bugs).
1546
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    77
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    78
== Priority ==
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    79
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
    80
3a9e63902b79 Add bug classification
Wuzzy <almikes@aol.com>
parents:
diff changeset
    81
For enhancements, the priority marks the “desirability” of the feature request. High-priority feature requests should generally be implemented before the lower priority ones.