diff --git a/topics/quality-gate.xml b/topics/quality-gate.xml
index fef26335..05dfc44a 100644
--- a/topics/quality-gate.xml
+++ b/topics/quality-gate.xml
@@ -8,17 +8,17 @@
-
Quality gate are quality control techniques that let you
- control your code quality and build software that meets your quality expectations. If a quality gate condition
- fails, %product% terminates using exit code 255, which makes a CI/CD workflow or pipeline fail. For example, if
- a quality gate for a project is set to 10 problems and code coverage is set to 40%, a build workflow will fail
- if %product% detects either an eleventh problem or code coverage below the 40% threshold.
+ Quality gates are techniques that let you control your code quality and build software that
+ meets your quality expectations. If a quality gate condition fails, %product% terminates using exit code 255,
+ which makes a CI/CD workflow or pipeline fail. For example, if a quality gate for a project is set to 10 problems
+ and code coverage is set to 40%, a build workflow will fail if %product% detects either an eleventh problem or
+ code coverage below the 40% threshold.
The terms quality gate, threshold and fail threshold
are used interchangeably.
- You can configure a single quality gate for an entire project, multiple quality gates for each separate
- problem severity, and
+
You can configure a single quality gate for the total number of project problems, multiple quality gates for
+ each separate problem severity, and
code coverage thresholds as explained in the table below.
@@ -49,9 +49,9 @@
%product% follows these rules:
- Given a project quality gate of A, when finding A problems, the run will succeed. When finding A+1 problems, the run will fail.
+ Given a total quality gate of A, when finding A problems, the run will succeed. When finding A+1 problems, the run will fail.
Given a severity quality gate of B, when finding B problems, the run will succeed. When finding B+1 problems, the run will fail.
- Given a code coverage threshold of C, when C% of lines are covered, the run will succeed. If only C-1% are covered, the run will fail.
+ Given a code coverage quality gate of C, when C% of lines are covered, the run will succeed. If only C-1% are covered, the run will fail.
If you configure a quality gate and baseline together, you'll be able to keep the number
@@ -59,7 +59,7 @@
-
+
You can configure a single quality gate for the entire project using the fail-threshold
option
available in all %product% linters, see examples below.
@@ -216,7 +216,7 @@
-
+
All linters except let you configure
separate quality gates for each problem severity, and