Merge pull request #201 from Trivadis/feature/issue-200-severity-categorization

PhilippSalvisberg · web-flow · commit a8a6280bf220 · 2023-09-08T18:10:41.000+02:00
Rework severity catagorization
diff --git a/docs/1-introduction/introduction.md b/docs/1-introduction/introduction.md
@@ -26,19 +26,19 @@ Testability | The capability of the software product to enable modified software
 ### Severity of the rule
 
 !!! bug "Blocker"
-    Will or may result in a bug.
+    Will or may result in a bug; for example, an incorrect result or a runtime exception.
 
 !!! danger "Critical"
-    Will have a high/direct impact on the maintenance cost.
+    Will have a high/direct impact on the maintenance cost. May have an impact on runtime behavior; for example, incomplete audit data or slower runtime performance.
 
 !!! warning "Major"
-    Will have a medium/potential impact on the maintenance cost.
+    Will have a medium/potential impact on the maintenance cost. May have an impact on runtime behavior; for example, higher memory consumption.
 
 !!! tip "Minor"
-    Will have a low impact on the maintenance cost.
+    Will have a low impact on the maintenance cost. No impact on the runtime behavior.
 
 !!! info "Info"
-    Very low impact; it is just a remediation cost report.
+    Very low impact; it is just a remediation cost report. No impact on runtime behavior. For example, a NOSONAR marker comment.
 
 ### Keywords used
 
diff --git a/docs/4-language-usage/1-general/g-1030.md b/docs/4-language-usage/1-general/g-1030.md
@@ -1,6 +1,6 @@
 # G-1030: Avoid defining variables that are not used.
 
-!!! tip "Minor"
+!!! warning "Major"
     Efficiency, Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/1-general/g-1040.md b/docs/4-language-usage/1-general/g-1040.md
@@ -1,6 +1,6 @@
 # G-1040: Avoid dead code.
 
-!!! tip "Minor"
+!!! warning "Major"
     Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/1-general/g-1060.md b/docs/4-language-usage/1-general/g-1060.md
@@ -1,6 +1,6 @@
 # G-1060: Avoid storing ROWIDs or UROWIDs in database tables.
 
-!!! warning "Major"
+!!! danger "Critical"
     Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/1-general/g-1080.md b/docs/4-language-usage/1-general/g-1080.md
@@ -1,6 +1,6 @@
 # G-1080: Avoid using the same expression on both sides of a relational comparison operator or a logical operator.
 
-!!! tip "Minor"
+!!! bug "Blocker"
     Maintainability, Efficiency, Testability
 
 ## Reason
diff --git a/docs/4-language-usage/2-variables-and-types/1-general/g-2145.md b/docs/4-language-usage/2-variables-and-types/1-general/g-2145.md
@@ -1,6 +1,6 @@
 # G-2145: Never self-assign a variable.
 
-!!! tip "Minor"
+!!! bug "Blocker"
     Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/2-variables-and-types/1-general/g-2185.md b/docs/4-language-usage/2-variables-and-types/1-general/g-2185.md
@@ -1,6 +1,6 @@
 # G-2185: Avoid using overly short names for explicitly or implicitly declared identifiers. 
 
-!!! tip "Minor"
+!!! warning "Major"
     Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/2-variables-and-types/1-general/g-2190.md b/docs/4-language-usage/2-variables-and-types/1-general/g-2190.md
@@ -1,6 +1,6 @@
 # G-2190: Avoid using ROWID or UROWID. 
 
-!!! warning "Major"
+!!! bug "Blocker"
     Portability, Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/2-variables-and-types/2-numeric-data-types/g-2210.md b/docs/4-language-usage/2-variables-and-types/2-numeric-data-types/g-2210.md
@@ -1,11 +1,11 @@
 # G-2210: Avoid declaring NUMBER variables, constants or subtypes with no precision.
 
-!!! tip "Minor"
+!!! warning "Major"
     Efficiency
 
 ## Reason
 
-If you do not specify precision `number` is defaulted to 38 or the maximum supported by your system, whichever is less. You may well need all this precision, but if you know you do not, you should specify whatever matches your needs.
+If you do not specify precision `number` is defaulted to 38 or the maximum supported by your system, whichever is less. You may well need all this precision, but if you know you do not, you should specify whatever matches your needs. Also, consider using a simpler data type that uses fewer resources, such as `pls_integer`.
 
 ## Example (bad)
 
diff --git a/docs/4-language-usage/2-variables-and-types/2-numeric-data-types/g-2220.md b/docs/4-language-usage/2-variables-and-types/2-numeric-data-types/g-2220.md
@@ -1,6 +1,6 @@
 # G-2220: Try to use PLS_INTEGER instead of NUMBER for arithmetic operations with integer values. 
 
-!!! tip "Minor"
+!!! danger "Critical"
     Efficiency
 
 ## Reason
diff --git a/docs/4-language-usage/2-variables-and-types/2-numeric-data-types/g-2230.md b/docs/4-language-usage/2-variables-and-types/2-numeric-data-types/g-2230.md
@@ -1,6 +1,6 @@
 # G-2230: Try to use SIMPLE_INTEGER datatype when appropriate. 
 
-!!! tip "Minor"
+!!! danger "Critical"
     Efficiency
 
 ## Reason
diff --git a/docs/4-language-usage/2-variables-and-types/3-character-data-types/g-2320.md b/docs/4-language-usage/2-variables-and-types/3-character-data-types/g-2320.md
@@ -1,7 +1,7 @@
 # G-2320: Never use VARCHAR data type.
 
-!!! warning "Major"
-    Portability
+!!! bug "Blocker"
+    Portability, Reliability
 
 ## Reason
 
diff --git a/docs/4-language-usage/2-variables-and-types/3-character-data-types/g-2330.md b/docs/4-language-usage/2-variables-and-types/3-character-data-types/g-2330.md
@@ -1,7 +1,7 @@
 # G-2330: Never use zero-length strings to substitute NULL.
 
-!!! warning "Major"
-    Portability
+!!! bug "Blocker"
+    Portability, Reliability
 
 ## Reason
 
diff --git a/docs/4-language-usage/2-variables-and-types/3-character-data-types/g-2340.md b/docs/4-language-usage/2-variables-and-types/3-character-data-types/g-2340.md
@@ -1,6 +1,6 @@
 # G-2340: Always define your VARCHAR2 variables using CHAR SEMANTIC (if not defined anchored).
 
-!!! tip "Minor"
+!!! bug "Blocker"
     Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/1-general/g-3110.md b/docs/4-language-usage/3-dml-and-sql/1-general/g-3110.md
@@ -1,6 +1,6 @@
 # G-3110: Always specify the target columns when coding an insert statement.
 
-!!! warning "Major"
+!!! bug "Blocker"
     Maintainability, Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/1-general/g-3115.md b/docs/4-language-usage/3-dml-and-sql/1-general/g-3115.md
@@ -1,6 +1,6 @@
 # G-3115: Avoid self-assigning a column.
 
-!!! tip "Minor"
+!!! bug "Blocker"
     Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/1-general/g-3130.md b/docs/4-language-usage/3-dml-and-sql/1-general/g-3130.md
@@ -1,6 +1,6 @@
 # G-3130: Try to use ANSI SQL-92 join syntax.
 
-!!! tip "Minor"
+!!! warning "Major"
     Maintainability, Portability
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/1-general/g-3145.md b/docs/4-language-usage/3-dml-and-sql/1-general/g-3145.md
@@ -1,6 +1,6 @@
 # G-3145: Avoid using SELECT * directly from a table or view.
 
-!!! warning "Major"
+!!! danger "Critical"
     Efficiency, Maintainability, Reliability, Testability
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/1-general/g-3150.md b/docs/4-language-usage/3-dml-and-sql/1-general/g-3150.md
@@ -1,6 +1,6 @@
 # G-3150: Try to use identity columns for surrogate keys.
 
-!!! tip "Minor"
+!!! danger "Critical"
     Maintainability, Reliability
 
 ## Restriction
diff --git a/docs/4-language-usage/3-dml-and-sql/1-general/g-3185.md b/docs/4-language-usage/3-dml-and-sql/1-general/g-3185.md
@@ -1,6 +1,6 @@
 # G-3185: Never use ROWNUM at the same query level as ORDER BY.
 
-!!! warning "Major"
+!!! bug "Blocker"
     Reliability, Testability
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/1-general/g-3190.md b/docs/4-language-usage/3-dml-and-sql/1-general/g-3190.md
@@ -1,6 +1,6 @@
 # G-3190: Avoid using NATURAL JOIN.
 
-!!! warning "Major"
+!!! bug "Blocker"
     Changeability, Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/1-general/g-3195.md b/docs/4-language-usage/3-dml-and-sql/1-general/g-3195.md
@@ -1,6 +1,6 @@
 # G-3195: Always use wildcards in a LIKE clause.
 
-!!! tip "Minor"
+!!! bug "Blocker"
     Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/2-bulk-operations/g-3210.md b/docs/4-language-usage/3-dml-and-sql/2-bulk-operations/g-3210.md
@@ -1,6 +1,6 @@
 # G-3210: Always use BULK OPERATIONS (BULK COLLECT, FORALL) whenever you have to execute a DML statement for more than 4 times.
 
-!!! warning "Major"
+!!! danger "Critical"
     Efficiency
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/2-bulk-operations/g-3220.md b/docs/4-language-usage/3-dml-and-sql/2-bulk-operations/g-3220.md
@@ -1,6 +1,6 @@
 # G-3220: Always process saved exceptions from a FORALL statement.
 
-!!! warning "Major"
+!!! danger "Critical"
     Reliability, Testability
 
 ## Reason
diff --git a/docs/4-language-usage/3-dml-and-sql/3-transaction-control/g-3310.md b/docs/4-language-usage/3-dml-and-sql/3-transaction-control/g-3310.md
@@ -1,6 +1,6 @@
 # G-3310: Never commit within a cursor loop.
 
-!!! danger "Critical"
+!!! bug "Blocker"
     Efficiency, Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/1-cursor/g-4120.md b/docs/4-language-usage/4-control-structures/1-cursor/g-4120.md
@@ -1,6 +1,6 @@
 # G-4120: Avoid using %NOTFOUND directly after the FETCH when working with BULK OPERATIONS and LIMIT clause. 
 
-!!! danger "Critical"
+!!! bug "Blocker"
     Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/1-cursor/g-4130.md b/docs/4-language-usage/4-control-structures/1-cursor/g-4130.md
@@ -1,6 +1,6 @@
 # G-4130: Always close locally opened cursors.
 
-!!! warning "Major"
+!!! bug "Blocker"
     Efficiency, Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/1-cursor/g-4140.md b/docs/4-language-usage/4-control-structures/1-cursor/g-4140.md
@@ -1,6 +1,6 @@
 # G-4140: Avoid executing any statements between a SQL operation and the usage of an implicit cursor attribute.
 
-!!! warning "Major"
+!!! bug "Blocker"
     Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/2-case-if-decode-nvl-nvl2-coalesce/g-4210.md b/docs/4-language-usage/4-control-structures/2-case-if-decode-nvl-nvl2-coalesce/g-4210.md
@@ -1,6 +1,6 @@
 # G-4210: Try to use CASE rather than an IF statement with multiple ELSIF paths.
 
-!!! warning "Major"
+!!! tip "Minor"
     Maintainability, Testability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/2-case-if-decode-nvl-nvl2-coalesce/g-4220.md b/docs/4-language-usage/4-control-structures/2-case-if-decode-nvl-nvl2-coalesce/g-4220.md
@@ -1,6 +1,6 @@
 # G-4220: Try to use CASE rather than DECODE.
 
-!!! tip "Minor"
+!!! warning "Major"
     Maintainability, Portability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/2-case-if-decode-nvl-nvl2-coalesce/g-4250.md b/docs/4-language-usage/4-control-structures/2-case-if-decode-nvl-nvl2-coalesce/g-4250.md
@@ -1,6 +1,6 @@
 # G-4250: Avoid using identical conditions in different branches of the same IF or CASE statement.
 
-!!! warning "Major"
+!!! bug "Blocker"
     Maintainability, Reliability, Testability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/3-flow-control/g-4330.md b/docs/4-language-usage/4-control-structures/3-flow-control/g-4330.md
@@ -1,6 +1,6 @@
 # G-4330: Always use a CURSOR FOR loop to process the complete cursor results unless you are using bulk operations.
 
-!!! tip "Minor"
+!!! warning "Major"
     Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/3-flow-control/g-4340.md b/docs/4-language-usage/4-control-structures/3-flow-control/g-4340.md
@@ -1,6 +1,6 @@
 # G-4340: Always use a NUMERIC FOR loop to process a dense array.
 
-!!! tip "Minor"
+!!! warning "Major"
     Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/3-flow-control/g-4350.md b/docs/4-language-usage/4-control-structures/3-flow-control/g-4350.md
@@ -1,6 +1,6 @@
 # G-4350: Always use 1 as lower and COUNT() as upper bound when looping through a dense array. 
 
-!!! warning "Major"
+!!! bug "Blocker"
     Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/3-flow-control/g-4360.md b/docs/4-language-usage/4-control-structures/3-flow-control/g-4360.md
@@ -1,6 +1,6 @@
 # G-4360: Always use a WHILE loop to process a loose array.
 
-!!! tip "Minor"
+!!! danger "Critical"
     Efficiency
 
 ## Reason
diff --git a/docs/4-language-usage/4-control-structures/3-flow-control/g-4385.md b/docs/4-language-usage/4-control-structures/3-flow-control/g-4385.md
@@ -1,6 +1,6 @@
 # G-4385: Never use a cursor for loop to check whether a cursor returns data.
 
-!!! warning "Major"
+!!! danger "Critical"
     Efficiency
 
 ## Reason
diff --git a/docs/4-language-usage/5-exception-handling/g-5040.md b/docs/4-language-usage/5-exception-handling/g-5040.md
@@ -1,6 +1,6 @@
 # G-5040: Avoid use of WHEN OTHERS clause in an exception section without any other specific handlers.
 
-!!! warning "Major"
+!!! danger "Critical"
     Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/5-exception-handling/g-5050.md b/docs/4-language-usage/5-exception-handling/g-5050.md
@@ -1,4 +1,4 @@
-# G-5050: Avoid use of the RAISE_APPLICATION_ERROR built-in procedure with a hard-coded  20nnn error number or hard-coded message. 
+# G-5050: Avoid use of the RAISE_APPLICATION_ERROR built-in procedure with a hard-coded 20nnn error number or hard-coded message. 
 
 !!! warning "Major"
     Changeability, Maintainability
diff --git a/docs/4-language-usage/5-exception-handling/g-5070.md b/docs/4-language-usage/5-exception-handling/g-5070.md
@@ -1,6 +1,6 @@
 # G-5070: Avoid using Oracle predefined exceptions.
 
-!!! danger "Critical"
+!!! bug "Blocker"
     Reliability
 
 ## Reason
diff --git a/docs/4-language-usage/5-exception-handling/g-5080.md b/docs/4-language-usage/5-exception-handling/g-5080.md
@@ -1,6 +1,6 @@
 # G-5080: Always use FORMAT_ERROR_BACKTRACE when using FORMAT_ERROR_STACK or SQLERRM.
 
-!!! tip "Minor"
+!!! danger "Critical"
     Maintainability, Testability
 
 ## Reason
diff --git a/docs/4-language-usage/7-stored-objects/1-general/g-7125.md b/docs/4-language-usage/7-stored-objects/1-general/g-7125.md
@@ -1,6 +1,6 @@
 # G-7125: Always use CREATE OR REPLACE instead of CREATE alone.
 
-!!! tip "Minor"
+!!! warning "Major"
     Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/7-stored-objects/1-general/g-7150.md b/docs/4-language-usage/7-stored-objects/1-general/g-7150.md
@@ -1,6 +1,6 @@
 # G-7150: Try to remove unused parameters.
 
-!!! tip "Minor"
+!!! warning "Major"
     Efficiency, Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/7-stored-objects/2-packages/g-7210.md b/docs/4-language-usage/7-stored-objects/2-packages/g-7210.md
@@ -1,6 +1,6 @@
 # G-7210: Try to keep your packages small. Include only few procedures and functions that are used in the same context.
 
-!!! tip "Minor"
+!!! warning "Major"
     Efficiency, Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/7-stored-objects/2-packages/g-7250.md b/docs/4-language-usage/7-stored-objects/2-packages/g-7250.md
@@ -1,6 +1,6 @@
 # G-7250: Never use RETURN in package initialization block.
 
-!!! tip "Minor"
+!!! warning "Major"
     Maintainability
 
 ## Reason
diff --git a/docs/4-language-usage/7-stored-objects/3-procedures/g-7330.md b/docs/4-language-usage/7-stored-objects/3-procedures/g-7330.md
@@ -1,6 +1,6 @@
 # G-7330: Always assign values to OUT parameters.
 
-!!! tip "Major"
+!!! bug "Blocker"
     Maintainability, Testability
 
 ## Reason
diff --git a/docs/4-language-usage/7-stored-objects/4-functions/g-7450.md b/docs/4-language-usage/7-stored-objects/4-functions/g-7450.md
@@ -1,6 +1,6 @@
 # G-7450: Never return a NULL value from a BOOLEAN function.
 
-!!! warning "Major"
+!!! bug "Blocker"
     Reliability, Testability
 
 ## Reason
diff --git a/docs/4-language-usage/7-stored-objects/7-triggers/g-7740.md b/docs/4-language-usage/7-stored-objects/7-triggers/g-7740.md
diff --git a/docs/4-language-usage/7-stored-objects/8-sequences/g-7810.md b/docs/4-language-usage/7-stored-objects/8-sequences/g-7810.md
diff --git a/docs/4-language-usage/7-stored-objects/9-sql-macros/g-7910.md b/docs/4-language-usage/7-stored-objects/9-sql-macros/g-7910.md
diff --git a/docs/4-language-usage/8-patterns/1-checking-the-number-of-rows/g-8110.md b/docs/4-language-usage/8-patterns/1-checking-the-number-of-rows/g-8110.md
diff --git a/docs/4-language-usage/8-patterns/1-checking-the-number-of-rows/g-8120.md b/docs/4-language-usage/8-patterns/1-checking-the-number-of-rows/g-8120.md
diff --git a/docs/4-language-usage/8-patterns/2-access-objects-of-foreign-application-schemas/g-8210.md b/docs/4-language-usage/8-patterns/2-access-objects-of-foreign-application-schemas/g-8210.md
diff --git a/docs/4-language-usage/8-patterns/3-validating-input-parameter-size/g-8310.md b/docs/4-language-usage/8-patterns/3-validating-input-parameter-size/g-8310.md
diff --git a/docs/4-language-usage/8-patterns/4-ensure-single-execution-at-a-time-of-a-program-unit/g-8410.md b/docs/4-language-usage/8-patterns/4-ensure-single-execution-at-a-time-of-a-program-unit/g-8410.md
diff --git a/docs/4-language-usage/8-patterns/5-use-dbms-application-info-package-to-follow-progress-of-a-process/g-8510.md b/docs/4-language-usage/8-patterns/5-use-dbms-application-info-package-to-follow-progress-of-a-process/g-8510.md
diff --git a/docs/4-language-usage/9-function-usage/g-9010.md b/docs/4-language-usage/9-function-usage/g-9010.md
diff --git a/docs/4-language-usage/9-function-usage/g-9030.md b/docs/4-language-usage/9-function-usage/g-9030.md
diff --git a/docs/4-language-usage/9-function-usage/g-9040.md b/docs/4-language-usage/9-function-usage/g-9040.md
diff --git a/docs/9-appendix/appendix.md b/docs/9-appendix/appendix.md
