--- a/BugClassification.wiki Tue Sep 11 20:10:26 2018 +0200
+++ b/BugClassification.wiki Tue Sep 11 19:12:42 2018 +0100
@@ -1,4 +1,6 @@
-#summary Classification of bugs
+#summary Classification of bugs in Hedgewars
+
+= Bug classification =
We classiy [https://issues.hedgewars.org/describecomponents.cgi?product=Hedgewars bugs in Hedgewars] by 1) severity and 2) priority.
@@ -16,11 +18,13 @@
* *Critical*: Crashes and and similar show-stoppers
* *Major*: A key feature is broken or game quality is lowered significantly
* *Normal*: Less-important feature is kinda broken
- * *Minor*: Somethng is slightly irritating or weird
+ * *Minor*: Somethng is slightly irritating or weird, usual minor audiovisual glitches
* *Trivial*: Nitpicking
* *Enhancement*: Feature request (not a bug)
-=== Blocker ===
+=== Detailed description ===
+
+==== Blocker ====
Anything which must be fixed before release. Including:
* Hedgewars does not work at all on one of the main platforms
@@ -29,10 +33,10 @@
* Important build script broken
* Regression (a bug that did not exist in the previous release)
-=== Crticial ===
+==== Crticial ====
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.
-=== Major ===
+==== Major ====
A major feature of Hedgewars is obviously broken which lowers the quality notably. The game is still playable as a whole. Including:
* Any game-breaking bug. A key aspect of gameplay is broken in an important way, including weapon behaviour. Seriously affects balancing
@@ -42,7 +46,7 @@
* Broken video recorder
* Very annoying usability failure
-=== Normal ===
+==== Normal ====
A less-important feature of Hedgewars is kinda broken. Like:
* A gameplay aspect is a bit broken. It might affect gameplay negatively a bit. Workaround might be available
@@ -51,7 +55,7 @@
* Notable but unimportant graphical glitch
* Important broken translation
-=== Minor ===
+==== Minor ====
Bugs with low impact, including:
* Gameplay aspect is a bit weird/confusing, but not broken
@@ -61,7 +65,7 @@
* Subtly broken translations
* Code quality complaints
-=== Trivial ===
+==== Trivial ====
Anything less important than minor. For nitpickers and perfectionists. Rarely used. For bugs like:
* “Oh no! This image is off by 2 pixels!”