Skip to content

Commit

Permalink
feat: Add new Issue categories DOCS-660 (#2041)
Browse files Browse the repository at this point in the history
* feat: Add new Issue categories

* clean: Tweaks

* fix: Fix vale errors

* feat: Update repo dashboard and related screenshots

* Clean: Correct Issue categories case to match UI
  • Loading branch information
claudiacarpinteiro authored Feb 23, 2024
1 parent d6c9456 commit aa0c799
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions docs/faq/code-analysis/which-metrics-does-codacy-calculate.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,16 @@ Codacy displays grades on the following places:
Codacy calculates the number of issues in the following static code analysis categories:

<!--issue-categories-start-->
- **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
<!--issue-categories-end-->

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.
Expand Down
Binary file modified docs/repositories/images/repository-dashboard-coverage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/repositories/images/repository-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aa0c799

Please sign in to comment.