diff --git a/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md b/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md index 17088830ae..40236b0380 100644 --- a/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md +++ b/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md @@ -49,14 +49,16 @@ Codacy displays grades on the following places: Codacy calculates the number of issues in the following static code analysis categories: -- **Code Style:** Code formatting and syntax problems, such as variable names style and enforcing the use of brackets and quotation marks -- **Error Prone:** Code that may hide bugs and language keywords that should be used with caution, such as the operator `==` in JavaScript or `Option.get` in Scala -- **Code Complexity:** High complexity methods and classes that should be refactored +- **Code style:** Code formatting and syntax problems, such as variable names style and enforcing the use of brackets and quotation marks +- **Error prone:** Code that may hide bugs and language keywords that should be used with caution, such as the operator `==` in JavaScript or `Option.get` in Scala +- **Code complexity:** High complexity methods and classes that should be refactored - **Performance:** Code that can have performance problems - **Compatibility:** Mainly for frontend code, compatibility problems across different browser versions -- **Unused Code:** Unused variables and methods, code that can't be reached +- **Unused code:** Unused variables and methods, code that can't be reached - **Security:** Potential security vulnerabilities, including hard-coded passwords and keys (secret scanning), vulnerable dependencies (software composition analysis or SCA), and insecure code patterns (static application security testing or SAST). For more information, see the complete [list of security issue categories](../../organizations/managing-security-and-risk.md#supported-security-categories) - **Documentation:** Methods and classes that don't have the correct comment annotations +- **Best practice:** Code that doesn't follow the recommended coding standards and best practices +- **Comprehensibility:** Code that can be difficult to understand and modify Besides this, Codacy also allows you to compare issues across repositories with different sizes by calculating the issue cost **relative to a baseline of 1 point per line of code**, where the cost of each issue depends on its severity: Critical = 10 points, Medium = 5 points, Minor = 1 point. This means that if your repository has 50% issues, the amount and severity of the issues in your repository is half of the baseline. diff --git a/docs/repositories/images/repository-dashboard-coverage.png b/docs/repositories/images/repository-dashboard-coverage.png index b5a4544000..de6d2f0070 100644 Binary files a/docs/repositories/images/repository-dashboard-coverage.png and b/docs/repositories/images/repository-dashboard-coverage.png differ diff --git a/docs/repositories/images/repository-dashboard-issues-breakdown.png b/docs/repositories/images/repository-dashboard-issues-breakdown.png index bf06aa92d4..b300177280 100644 Binary files a/docs/repositories/images/repository-dashboard-issues-breakdown.png and b/docs/repositories/images/repository-dashboard-issues-breakdown.png differ diff --git a/docs/repositories/images/repository-dashboard-open-pull-requests.png b/docs/repositories/images/repository-dashboard-open-pull-requests.png index e69421e20d..800957ca4d 100644 Binary files a/docs/repositories/images/repository-dashboard-open-pull-requests.png and b/docs/repositories/images/repository-dashboard-open-pull-requests.png differ diff --git a/docs/repositories/images/repository-dashboard.png b/docs/repositories/images/repository-dashboard.png index c12a849bff..9158e67426 100644 Binary files a/docs/repositories/images/repository-dashboard.png and b/docs/repositories/images/repository-dashboard.png differ