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 622da79b62..60618185c9 100644 --- a/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md +++ b/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md @@ -96,7 +96,7 @@ Codacy displays complexity on the following places: ## Duplication -Codacy identifies clones or [sequences of duplicate code](https://en.wikipedia.org/wiki/Duplicate_code) that exist in at least two different places of the source code of your repository. Clones typically indicate deeper code quality issues and should be eliminated through abstraction when possible. +Codacy identifies clones or [sequences of duplicate code](https://en.wikipedia.org/wiki/Duplicate_code) that exist in at least two different places of the source code of your repository. Clones typically indicate deeper code issues and should be eliminated through abstraction when possible. Codacy calculates duplication as follows: diff --git a/docs/getting-started/integrating-codacy-with-intellij-ides.md b/docs/getting-started/integrating-codacy-with-intellij-ides.md index 8e63969d48..8eaf8a9248 100644 --- a/docs/getting-started/integrating-codacy-with-intellij-ides.md +++ b/docs/getting-started/integrating-codacy-with-intellij-ides.md @@ -1,6 +1,6 @@ # Integrating Codacy with IntelliJ IDEs -The [Codacy IntelliJ plugin](https://github.com/codacy/codacy-intellij-extension) is an open-source plugin for IntelliJ IDEs that lets you review the result of the Codacy analysis for a pull request, get the full list of problems found, and navigate to any Quality issue that you want to review and fix. +The [Codacy IntelliJ plugin](https://github.com/codacy/codacy-intellij-extension) is an open-source plugin for IntelliJ IDEs that lets you review the result of the Codacy analysis for a pull request, get the full list of problems found, and navigate to any issue that you want to review and fix. !!! info "To use this plugin you need a [Codacy account](https://www.codacy.com/signup-codacy)" @@ -12,15 +12,15 @@ The main view of the Codacy IntelliJ plugin provides a summary of the code quali In the main view, you can find the following information: -- The **Quality status** of the pull request, either up to standards or not up to standards, based on the [Quality gates](../repositories-configure/adjusting-quality-gates.md) set for the repository. +- The **Status** of the pull request, either up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository. -- Any **Quality issues** introduced or fixed by the pull request. These are the same issues you find in the [Quality Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in IntelliJ's Problems tab. +- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in IntelliJ's Problems tab. - When this item is expanded, the number next to each file name is the total number of Quality issues that the pull request adds to that file. + When this item is expanded, the number next to each file name is the total number of issues that the pull request adds to that file. - The **diff coverage** introduced by the pull request. The percentage next to each file name is the coverage variation for that file. -- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Quality Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app. +- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app. - Variations in **code complexity** introduced by the pull request. @@ -56,12 +56,12 @@ After completing these steps, the main view shows the result of the latest Codac ## Reviewing pull request issues -In the **Problems tool window**, Codacy displays the same Quality issues you find in the main view and lets you navigate to the exact line of code where the issue was found. +In the **Problems tool window**, Codacy displays the same issues you find in the main view and lets you navigate to the exact line of code where the issue was found. !!! note Code coverage, duplicates, and complexity aren't currently shown in the Problems tool window. -To review Quality issues: +To review issues: 1. Open the file you want to review. diff --git a/docs/getting-started/integrating-codacy-with-visual-studio-code.md b/docs/getting-started/integrating-codacy-with-visual-studio-code.md index a96d847474..cbbc0f9088 100644 --- a/docs/getting-started/integrating-codacy-with-visual-studio-code.md +++ b/docs/getting-started/integrating-codacy-with-visual-studio-code.md @@ -2,7 +2,7 @@ The [Codacy Visual Studio Code extension](https://github.com/codacy/codacy-vscode-extension) is an open-source project that enables developers to review directly in VS Code the result of Codacy analysis for the pull requests they’re working on. -Use this extension to get the full list of problems found by Codacy for a pull request and navigate to any Quality issue that you want to review and fix. +Use this extension to get the full list of problems found by Codacy for a pull request and navigate to any issue that you want to review and fix. !!! info "To use this extension you need a [Codacy account](https://www.codacy.com/signup-codacy)" @@ -20,11 +20,11 @@ The main view of the extension displays information about the code quality and c The **Pull request status** tab displays the following information for the pull request of the currently checked-out branch: -- The **Quality status** of the pull request, either up to standards or not up to standards, based on the [Quality gates](../repositories-configure/adjusting-quality-gates.md) set for the repository. +- The **Status** of the pull request, either up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository. -- Any **Quality issues** introduced or fixed by the pull request. These are the same issues you find in the [Quality Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in VS Code's Problems tab. +- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in VS Code's Problems tab. - When this item is expanded, the number next to each file name is the total number of Quality issues that the pull request adds to or removes from that file. The number farther to the right, added by VS Code, is the total number of problems in that file, which may or may not be Quality issues from Codacy. If there are any Medium or Critical Quality issues, the file name is also highlighted in yellow (Medium) or red (Critical). + When this item is expanded, the number next to each file name is the total number of issues that the pull request adds to or removes from that file. The number farther to the right, added by VS Code, is the total number of problems in that file, which may or may not be issues from Codacy. If there are any Medium or Critical issues, the file name is also highlighted in yellow (Medium) or red (Critical). ![Important issues](./images/codacy-vscode-extension-important-issues.png) @@ -34,7 +34,7 @@ The **Pull request status** tab displays the following information for the pull ![Toggle inline coverage](./images/codacy-vscode-extension-inline-coverage.png) -- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Quality Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app. +- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app. - Variations in **code complexity** introduced by the pull request. @@ -48,15 +48,15 @@ The **Open Pull Requests** tab lists all open pull requests for the repository, - Analyzing, if Codacy is analyzing the branch. - - Up to standards or not up to standards, based on the [Quality gates](../repositories-configure/adjusting-quality-gates.md) set for the repository. + - Up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository. - The author of the pull request. - The source and target branches of the pull request. -- Any **Quality issues** introduced or fixed by the pull request. These are the same issues you find in the [Quality Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app. +- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app. -- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Quality Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app. +- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app. - Variations in **code complexity** introduced by the pull request. This is the same value you find on the [Pull request quality overview](../repositories/pull-requests.md#quality-overview) in the Codacy app. @@ -64,7 +64,7 @@ The **Open Pull Requests** tab lists all open pull requests for the repository, ![Analyzed branch tab UI](images/codacy-vscode-extension-analyzed-branch-tab.png) -The **Analyzed Branch** tab appears if you switch to an analyzed branch that doesn't have an open pull request, such as the `main` or `master` branch. This tab shows an overview of the Quality issues found in that branch, grouped by recently added, introduced by the current user, issue category, and issue severity. +The **Analyzed Branch** tab appears if you switch to an analyzed branch that doesn't have an open pull request, such as the `main` or `master` branch. This tab shows an overview of the issues found in that branch, grouped by recently added, introduced by the current user, issue category, and issue severity. See [how to manage the analysis of your repository's branches](../repositories-configure/managing-branches.md). @@ -99,16 +99,16 @@ To see Codacy quality and coverage data for an open pull request, follow these s 1. Check out the pull request of interest. You can do it either manually or from the **Open Pull Requests** tab, by clicking the arrow button or using the contextual right-click menu. -After completing these steps, the main view shows the result of the latest Codacy analysis for the pull request. The VS Code Problems tab lists the Quality issues found. +After completing these steps, the main view shows the result of the latest Codacy analysis for the pull request. The VS Code Problems tab lists the issues found. ## Reviewing pull request issues -In the **Problems tab**, Codacy displays the same Quality issues you find in the **Status tab** and lets you navigate to the exact line of code where the issue was found. +In the **Problems tab**, Codacy displays the same issues you find in the **Status tab** and lets you navigate to the exact line of code where the issue was found. !!! note Code coverage, duplicates, and complexity aren't currently shown in the Problems tab. -To review Quality issues: +To review issues: 1. Open the **Problems tab** (use `Ctrl+Shift+M` on Windows/Linux or `Cmd+Shift+M` on macOS). diff --git a/docs/repositories-configure/adjusting-quality-gates.md b/docs/repositories-configure/adjusting-quality-gates.md index 3c60001430..c8eef16f15 100644 --- a/docs/repositories-configure/adjusting-quality-gates.md +++ b/docs/repositories-configure/adjusting-quality-gates.md @@ -14,7 +14,7 @@ Depending on the result of applying the quality gate rules, Codacy updates the c To access the quality gates, open your repository **Settings**, tab **Gates**. -![Quality gates](images/quality-settings-gates.png) +![Gates](images/quality-settings-gates.png) - **New issues are over:** Pull requests or commits are marked not up to standards if the number of issues introduced that have at least the specified severity level is higher than the set value. - **New security issues are over:** Pull requests or commits are marked not up to standards if the number of security issues introduced is higher than the set value. diff --git a/docs/repositories-configure/adjusting-quality-goals.md b/docs/repositories-configure/adjusting-quality-goals.md index b6e8f0ae53..9b5a0684b4 100644 --- a/docs/repositories-configure/adjusting-quality-goals.md +++ b/docs/repositories-configure/adjusting-quality-goals.md @@ -2,11 +2,11 @@ Adjust the **quality goals** to help you monitor the progress of the code quality in your repository dashboard, and configure which files Codacy considers complex or duplicated. -Codacy displays the quality goals as dashed lines on the [quality evolution chart](../repositories/repository-dashboard.md#quality-evolution-chart) to help you monitor the progress and overall quality status of your repository. +Codacy displays the quality goals as dashed lines on the [quality evolution chart](../repositories/repository-dashboard.md#evolution-chart) to help you monitor the progress and overall quality status of your repository. To access the quality goals, open your repository **Settings**, tab **Goals**. The following screenshot displays the default configuration values: -![Quality goals](images/quality-settings-goals.png) +![Goals](images/quality-settings-goals.png) - **Issues are over:** Defines the threshold displayed on the tab **Issues** of the quality evolution chart. - **Complexity is over:** Defines the threshold displayed on the tab **Complexity** of the quality evolution chart. diff --git a/docs/repositories/commits.md b/docs/repositories/commits.md index 0fcb77bfac..32aabd4594 100644 --- a/docs/repositories/commits.md +++ b/docs/repositories/commits.md @@ -3,9 +3,9 @@ page_name: "commit" file_name: "commits" --- -# Quality Commits page +# Commits page -The **Quality Commits page** displays an overview of the commits in your repository, such as the analysis status and the code quality metrics for each commit. This allows you to monitor the evolution of the code quality per commit in your repository. +The **Commits page** displays an overview of the commits in your repository, such as the analysis status and the code quality metrics for each commit. This allows you to monitor the evolution of the code quality per commit in your repository. By default, the page lists the commits on the main branch of your repository, but if you have [more than one branch enabled](../repositories-configure/managing-branches.md) you can use the drop-down list at the top of the page to display commits on other branches. diff --git a/docs/repositories/coverage.md b/docs/repositories/coverage.md index 174114290a..6ff23a0a31 100644 --- a/docs/repositories/coverage.md +++ b/docs/repositories/coverage.md @@ -1,6 +1,6 @@ -# Quality Coverage page +# Coverage page -The **Quality Coverage page** displays the current code coverage information in your [enabled repository branches](../repositories-configure/managing-branches.md). +The **Coverage page** displays the current code coverage information in your [enabled repository branches](../repositories-configure/managing-branches.md). If your repository doesn't have coverage set up, you can learn more on how to [add coverage to your repository](../coverage-reporter/index.md). diff --git a/docs/repositories/files.md b/docs/repositories/files.md index 07931fe715..c943421b1e 100644 --- a/docs/repositories/files.md +++ b/docs/repositories/files.md @@ -1,6 +1,6 @@ -# Quality Files page +# Files page -The **Quality Files page** displays the current code quality information for each analyzed file in your [enabled repository branches](../repositories-configure/managing-branches.md). +The **Files page** displays the current code quality information for each analyzed file in your [enabled repository branches](../repositories-configure/managing-branches.md). By default, the page lists the files on the main branch of your repository. However, if you have [more than one branch enabled](../repositories-configure/managing-branches.md), you can select other branches using the drop-down list at the top of the page. @@ -36,7 +36,7 @@ The header of the file detail page displays the same code quality metrics as the Depending on the available analysis information for the file, Codacy displays one or more of the following tabs: -- **Issues:** Shows the annotated source code on the left-hand side and the matching list of issues and issue distribution by severity on the right-hand side. Each listed issue includes the same information and options available on the [Quality Issues page](issues.md). +- **Issues:** Shows the annotated source code on the left-hand side and the matching list of issues and issue distribution by severity on the right-hand side. Each listed issue includes the same information and options available on the [Issues page](issues.md). ![Issues for a file](images/files-issues.png) diff --git a/docs/repositories/issues.md b/docs/repositories/issues.md index b725544fd6..ca1e50163e 100644 --- a/docs/repositories/issues.md +++ b/docs/repositories/issues.md @@ -1,6 +1,6 @@ -# Quality Issues page +# Issues page -The **Quality Issues page** lists all the issues that Codacy detected in your repository, including the severity level and category of each issue. +The **Issues page** lists all the issues that Codacy detected in your repository, including the severity level and category of each issue. By default, the page lists the issues on the main branch of your repository but if you have [more than one branch enabled](../repositories-configure/managing-branches.md) you can use the drop-down list at the top of the page to display issues on other branches. diff --git a/docs/repositories/pull-requests.md b/docs/repositories/pull-requests.md index 47211c11e7..f51c187839 100644 --- a/docs/repositories/pull-requests.md +++ b/docs/repositories/pull-requests.md @@ -3,9 +3,9 @@ page_name: "pull request" file_name: "pull-requests" --- -# Quality Pull Requests page +# Pull Requests page -The **Quality Pull Requests page** displays an overview of the pull requests in your repository, such as the analysis status and the code quality metrics for each pull request. This allows you to monitor the code quality of the work in progress in your repository. +The **Pull Requests page** displays an overview of the pull requests in your repository, such as the analysis status and the code quality metrics for each pull request. This allows you to monitor the code quality of the work in progress in your repository. By default, the page lists open pull requests, but you can click the **Closed** tab at the top of the list to display the closed pull requests. diff --git a/docs/repositories/repository-dashboard.md b/docs/repositories/repository-dashboard.md index 8ea1ccee57..380c8712f8 100644 --- a/docs/repositories/repository-dashboard.md +++ b/docs/repositories/repository-dashboard.md @@ -1,6 +1,6 @@ -# Quality Repository Dashboard +# Repository Dashboard -The **Quality Repository Dashboard** provides an overview of the repository code quality and items that require your attention. +The **Repository Dashboard** provides an overview of the repository code quality and items that require your attention. To access your Repository Dashboard, select a repository from the [Repositories list](../organizations/managing-repositories.md) and select **Dashboard** on the left navigation sidebar. @@ -16,7 +16,7 @@ The top of the Repository Dashboard displays: On the Repository Dashboard you have the following areas to help you monitor your repository: -- [Quality evolution chart](#quality-evolution-chart) +- [Evolution chart](#evolution-chart) - [Issues breakdown](#issues-breakdown) - [Coverage](#coverage) - [Open pull requests](#open-pull-requests) @@ -25,9 +25,9 @@ The following sections provide a detailed overview of each dashboard area. {% include-markdown "../assets/includes/dashboard-api-report-note.md" %} -## Quality evolution chart +## Evolution chart -The **Quality evolution** chart displays the evolution of the repository code quality regarding [issues](../faq/code-analysis/which-metrics-does-codacy-calculate.md#issues), [complex files](../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity), [duplication](../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication), and [code coverage](../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage). Click on **Last 3 months**, **Last 31 days**, or **Last 7 days** to select the time interval of the historical data to display on the chart. +The **Evolution** chart displays the evolution of the repository code quality regarding [issues](../faq/code-analysis/which-metrics-does-codacy-calculate.md#issues), [complex files](../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity), [duplication](../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication), and [code coverage](../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage). Click on **Last 3 months**, **Last 31 days**, or **Last 7 days** to select the time interval of the historical data to display on the chart. Each tab displays the following information for the corresponding metric: @@ -40,7 +40,7 @@ Each tab displays the following information for the corresponding metric: The chart also displays the **trendline** based on the past behavior and the [quality goals](../repositories-configure/adjusting-quality-goals.md) defined for the repository. -![Quality evolution chart](images/repository-dashboard-quality-evolution.png) +![Evolution chart](images/repository-dashboard-quality-evolution.png) ## Issues breakdown @@ -48,7 +48,7 @@ The **Issues breakdown** area displays the total number of issues found on the s Click **See all issues** to see the full [list of issues](issues.md) found, or click a category to see the issues in that category. -If Codacy detects code patterns that have suggested fixes, a **Fix issues** button appears below the total issue count. Click this button to open a modal with a patch that addresses all resolvable issues, and follow the [same procedure outlined on the Quality Issues page](./issues.md#fixing-issues-automatically). +If Codacy detects code patterns that have suggested fixes, a **Fix issues** button appears below the total issue count. Click this button to open a modal with a patch that addresses all resolvable issues, and follow the [same procedure outlined on the Issues page](./issues.md#fixing-issues-automatically). ![Issues breakdown](images/repository-dashboard-issues-breakdown.png) diff --git a/mkdocs.yml b/mkdocs.yml index e4d6c973e2..e467be20f8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -562,7 +562,7 @@ nav: - getting-started/supported-languages-and-tools.md - getting-started/which-permissions-does-codacy-need-from-my-account.md - getting-started/adding-a-codacy-badge.md - - Repositories on Codacy Quality: + - Repositories on Codacy: - repositories/repository-dashboard.md - repositories/commits.md - repositories/files.md