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 5d0dadd005..837ed900c9 100644 --- a/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md +++ b/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md @@ -82,7 +82,7 @@ Codacy calculates complexity as follows: - The complexity value for each file is the highest cyclomatic complexity of the methods in the file. - A file is considered complex if its cyclomatic complexity value is higher than the threshold [**File is complex when over**](../../repositories-configure/adjusting-quality-goals.md). -- The complexity value of a commit or pull request is the sum of the cyclomatic complexity of the files that were changed in the commit or pull request and that have complexity higher than 4. +- The complexity value of a commit or pull request is the sum of the cyclomatic complexity of the files that were changed in the commit or pull request and that have a high complexity increase, defined as an increase of 4 or more. Codacy displays complexity on the following places: diff --git a/docs/faq/repositories/how-do-i-reanalyze-my-repository.md b/docs/faq/repositories/how-do-i-reanalyze-my-repository.md index 629667a469..59391f6975 100644 --- a/docs/faq/repositories/how-do-i-reanalyze-my-repository.md +++ b/docs/faq/repositories/how-do-i-reanalyze-my-repository.md @@ -26,7 +26,7 @@ To reanalyze a branch in your repository: ![Selecting the last commit on a branch](images/reanalyze-repository-commits-list.png) -1. Click the icon next to the **Current status** of the commit to trigger a reanalysis. Codacy will display a message when the analysis is complete. +1. Click the **Reanalyze** link to trigger a reanalysis. Codacy will display the status of the reanalysis request. ![Reanalyzing a commit](images/reanalyze-repository-commit.png) @@ -38,7 +38,7 @@ To reanalyze a pull request in your repository: ![Selecting a pull request](images/reanalyze-repository-prs-list.png) -1. Click the icon next to the **Current status** of the pull request to trigger a reanalysis. Codacy will display a message when the analysis is complete. +1. Click the **Reanalyze** button to trigger a reanalysis. Codacy will display the status of the reanalysis request. ![Reanalyzing a pull request](images/reanalyze-repository-pr.png) diff --git a/docs/faq/repositories/images/reanalyze-repository-commit.png b/docs/faq/repositories/images/reanalyze-repository-commit.png index b4d7c3d154..7b6c821ce1 100644 Binary files a/docs/faq/repositories/images/reanalyze-repository-commit.png and b/docs/faq/repositories/images/reanalyze-repository-commit.png differ diff --git a/docs/faq/repositories/images/reanalyze-repository-commits-list.png b/docs/faq/repositories/images/reanalyze-repository-commits-list.png index 2c2acbacfe..136533cf43 100644 Binary files a/docs/faq/repositories/images/reanalyze-repository-commits-list.png and b/docs/faq/repositories/images/reanalyze-repository-commits-list.png differ diff --git a/docs/faq/repositories/images/reanalyze-repository-pr.png b/docs/faq/repositories/images/reanalyze-repository-pr.png index f694767f14..55f0cc478f 100644 Binary files a/docs/faq/repositories/images/reanalyze-repository-pr.png and b/docs/faq/repositories/images/reanalyze-repository-pr.png differ diff --git a/docs/faq/repositories/images/reanalyze-repository-prs-list.png b/docs/faq/repositories/images/reanalyze-repository-prs-list.png index 018b33bfe4..aeaef2ac0f 100644 Binary files a/docs/faq/repositories/images/reanalyze-repository-prs-list.png and b/docs/faq/repositories/images/reanalyze-repository-prs-list.png differ diff --git a/docs/faq/troubleshooting/images/duplication-commits.png b/docs/faq/troubleshooting/images/duplication-commits.png index 5eeca83f92..839804c52b 100644 Binary files a/docs/faq/troubleshooting/images/duplication-commits.png and b/docs/faq/troubleshooting/images/duplication-commits.png differ diff --git a/docs/faq/troubleshooting/images/duplication-logs.png b/docs/faq/troubleshooting/images/duplication-logs.png deleted file mode 100644 index 0d30180efa..0000000000 Binary files a/docs/faq/troubleshooting/images/duplication-logs.png and /dev/null differ diff --git a/docs/faq/troubleshooting/images/error-line-endings.png b/docs/faq/troubleshooting/images/error-line-endings.png index 626c4a82f4..69a844e312 100644 Binary files a/docs/faq/troubleshooting/images/error-line-endings.png and b/docs/faq/troubleshooting/images/error-line-endings.png differ diff --git a/docs/faq/troubleshooting/why-arent-duplication-metrics-being-calculated.md b/docs/faq/troubleshooting/why-arent-duplication-metrics-being-calculated.md index 127e105920..0687107fed 100644 --- a/docs/faq/troubleshooting/why-arent-duplication-metrics-being-calculated.md +++ b/docs/faq/troubleshooting/why-arent-duplication-metrics-being-calculated.md @@ -10,14 +10,12 @@ When this happens, Codacy doesn't display code duplication metrics for the affec ![Duplication in the Files page](images/duplication-files.png) -- The **Commits** and **Pull Request** pages display an empty **New Duplication** tab. +- The **Commits** and **Pull Request** pages display an empty **Duplication** tab. ![New duplication for a commit](images/duplication-commits.png) - The analysis logs for commits won't display a duplication analysis task for the tool corresponding to the affected language. - ![Analysis logs for a commit](images/duplication-logs.png) - As a workaround, if you're exceeding the maximum number of source code files: 1. Use a [Codacy configuration file](../../repositories-configure/codacy-configuration-file.md) to exclude source code files of the affected language from your project to decrease the number of files to be analyzed. diff --git a/docs/repositories-configure/integrations/bitbucket-integration.md b/docs/repositories-configure/integrations/bitbucket-integration.md index ab6dad1b77..47a7babd49 100644 --- a/docs/repositories-configure/integrations/bitbucket-integration.md +++ b/docs/repositories-configure/integrations/bitbucket-integration.md @@ -6,10 +6,6 @@ description: Enable the Bitbucket integration to have pull request status, comme The Bitbucket integration incorporates Codacy on your existing Git provider workflows by reporting issues and the analysis status directly on your pull requests. -When this integration is enabled, you can also create pull request comments directly from Codacy when browsing the existing repository issues on the [commit issue tabs](../../repositories/commits.md#issues-tabs) or on the [pull request issue tabs](../../repositories/pull-requests.md#issues-tabs): - -![Bitbucket integration for issues](images/bitbucket-integration-issues.png) - ## Enabling the Bitbucket integration {: id="enabling"} To enable the Bitbucket integration, open your repository **Settings**, tab **Integrations**. When you add a new repository, Codacy enables the integration using the [default settings for your organization](../../organizations/integrations/default-git-provider-integration-settings.md). diff --git a/docs/repositories-configure/integrations/github-integration.md b/docs/repositories-configure/integrations/github-integration.md index 639b3a8414..9427580beb 100644 --- a/docs/repositories-configure/integrations/github-integration.md +++ b/docs/repositories-configure/integrations/github-integration.md @@ -6,10 +6,6 @@ description: Enable the GitHub integration to have status checks, annotations, i The GitHub integration incorporates Codacy on your existing Git provider workflows by reporting issues and the analysis status directly on your pull requests. -When this integration is enabled, you can also create pull request comments directly from Codacy when browsing the existing repository issues on the [commit issue tabs](../../repositories/commits.md#issues-tabs) or on the [pull request issue tabs](../../repositories/pull-requests.md#issues-tabs) of a repository: - -![GitHub integration for issues](images/github-integration-issues.png) - ## Enabling the GitHub integration {: id="enabling"} To enable the GitHub integration, open your repository **Settings**, tab **Integrations**. When you add a new repository, Codacy enables the integration using the [default settings for your organization](../../organizations/integrations/default-git-provider-integration-settings.md). diff --git a/docs/repositories-configure/integrations/images/bitbucket-integration-issues.png b/docs/repositories-configure/integrations/images/bitbucket-integration-issues.png deleted file mode 100644 index 4ead347191..0000000000 Binary files a/docs/repositories-configure/integrations/images/bitbucket-integration-issues.png and /dev/null differ diff --git a/docs/repositories-configure/integrations/images/github-integration-issues.png b/docs/repositories-configure/integrations/images/github-integration-issues.png deleted file mode 100644 index 835c376b60..0000000000 Binary files a/docs/repositories-configure/integrations/images/github-integration-issues.png and /dev/null differ diff --git a/docs/repositories-coverage/commits.md b/docs/repositories-coverage/commits.md index 89fe42a15f..f836a6ecfe 100644 --- a/docs/repositories-coverage/commits.md +++ b/docs/repositories-coverage/commits.md @@ -66,9 +66,13 @@ This area displays the coverage gate status and an overview of the coverage metr +{% if page.meta.product == "coverage" %} ## Diff tab +{% else %} +## Coverage tab +{% endif %} -The **Diff** tab displays a line-by-line view of the coverage variation introduced by the {{ page.meta.page_name }}. It includes the following areas: +The {% if page.meta.product == "coverage" %}**Diff**{% else %}**Coverage**{% endif %} tab displays a line-by-line view of the coverage variation introduced by the {{ page.meta.page_name }}. It includes the following areas: - A **list of files** modified by the {{ page.meta.page_name }}, with additional information for each file: @@ -82,7 +86,11 @@ The **Diff** tab displays a line-by-line view of the coverage variation introduc - **No background**: Non-coverable line +{% if page.meta.product == "coverage" %} ![Diff tab](images/{{ page.meta.file_name }}-tab-diff.png) +{% else %} +![Coverage tab](images/{{ page.meta.file_name }}-tab-coverage.png) +{% endif %} diff --git a/docs/repositories/commits.md b/docs/repositories/commits.md index b4cc5374fd..1079f43cc6 100644 --- a/docs/repositories/commits.md +++ b/docs/repositories/commits.md @@ -5,9 +5,9 @@ file_name: "commits" # Quality 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 in your repository per commit. +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. -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. +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. ![Commits page](images/commits.png) @@ -19,33 +19,37 @@ The next sections describe each area of the commit detail page. ## Commit status {: id="status"} -This area displays the information that identifies the commit (SHA hash, date, and commit message), as well as: +![Commit status](images/commits-detail-status.png) -- The analysis status and a [button to reanalyze the commit](../faq/repositories/how-do-i-reanalyze-my-repository.md) (enabled when the committer [is part of your organization](../organizations/managing-people.md)) -- A link to the analysis logs -- A link to the commit on your Git provider +This area displays the information that identifies the commit (commit message, committer, SHA hash, and last updated date), as well as: -![Commit status](images/commits-detail-status.png) +- A link to the commit on your Git provider +- A [link to reanalyze the commit](../faq/repositories/how-do-i-reanalyze-my-repository.md), present when the committer [is part of your organization](../organizations/managing-people.md) +- A link to the analysis logs ## {{ page.meta.page_name.capitalize() }} quality overview {: id="quality-overview"} -This area displays the quality gate status and an overview of the code quality metrics for the {{ page.meta.page_name }}: + +![{{ page.meta.page_name.capitalize() }} quality overview](images/{{ page.meta.file_name }}-detail-quality-overview.png) + + +This area displays the quality gate status for the {{ page.meta.page_name }} and the code quality metrics [with a gate set up](../repositories-configure/adjusting-quality-gates.md): -- The quality gate status is either **Failed quality gates** or **Passed quality gates** depending on the [quality gate rules](../repositories-configure/adjusting-quality-gates.md) for your repository. +- The quality gate status is either **Up to quality standards** or **Not up to quality standards** depending on the [quality gate rules](../repositories-configure/adjusting-quality-gates.md) for your repository. - If you don't have any rules enabled for {{ page.meta.page_name }}s, the status is always **Passed quality gates**. + If there are no gate rules enabled for {{ page.meta.page_name }}s, the status is always **Up to quality standards**. -- The variation of the following code quality metrics introduced by the {{ page.meta.page_name }} is displayed either as a **positive or negative variation**, {% if page.meta.page_name == "commit" %}or **no variation** (represented by `=`){% else %}**no variation** (represented by `=`), or **not applicable** (represented by `∅`){% endif %}: +- The variation introduced by the {{ page.meta.page_name }} is displayed either as a **positive or negative variation**, {% if page.meta.page_name == "commit" %}or **no variation** (represented by `=`){% else %}**no variation** (represented by `=`), or **not applicable** (represented by `∅`){% endif %} for code quality metrics [with a gate set up](../repositories-configure/adjusting-quality-gates.md): - **Issues:** Number of new issues - - **Duplication:** Variation of the number of duplicated code blocks - - **Complexity:** Variation of complexity + - **Duplication:** Changes in the number of duplicated code blocks + - **Complexity:** Changes in code complexity {% if page.meta.page_name == "commit" %} - - **Coverage:** Variation of code coverage percentage relative to the parent commit + - **Coverage variation:** Changes in code coverage percentage compared with the parent commit {% else %} - - **Coverage variation:** Variation of code coverage percentage relative to the target branch - - **Diff coverage:** Code coverage of the coverable lines added or changed by the pull request, or `∅` (not applicable) if there aren't any coverable lines added or changed + - **Diff coverage:** Code coverage of the coverable lines affected by the pull request, or `∅` (not applicable) if there are no coverable lines + - **Coverage variation:** Changes in code coverage percentage compared with the target branch {% endif %} Depending on the languages being analyzed or if you haven't [set up coverage for your repository](../coverage-reporter/index.md), some metrics **may not be calculated** (represented by `-`). @@ -60,61 +64,75 @@ This area displays the quality gate status and an overview of the code quality m - **Green:** The metric passes the quality gate - **Red:** The metric fails the quality gate - - **Gray:** There aren't quality gate rules configured for the metric or the value doesn't impact the quality gate + - **Gray:** The metric has no value - !!! notes - If you change the quality gate rules you must reanalyze the {{ page.meta.page_name }} to update the color of the metrics, except for coverage which updates immediately after you save your changes on the Quality Settings page. - - -![{{ page.meta.page_name.capitalize() }} quality overview](images/{{ page.meta.file_name }}-detail-quality-overview.png) - + !!! note + If you change the quality gate rules you must reanalyze the {{ page.meta.page_name }} to update the metrics and optionally re-upload the Coverage report if you also changed the coverage gate rules. -## Issues tabs +## Issues tab {: id="issues-tabs"} -The **New Issues** and **Fixed Issues** tabs display the list of issues that the commit created or fixed. +The **Issues** tab displays the lists of issues that the {{ page.meta.page_name }} creates or fixes. Use the sidebar filters to filter the list by new issues (including issues of specific severity or category), issues within a specific file, fixed issues, [potential new issues, or potential fixed issues](#possible-issues). -Click the title of an issue to see the following information: +{% + include-markdown "./issues.md" + start="" + end="" +%} -- The committer and date of the commit that introduced the issue -- The [tool that reported the issue](../getting-started/supported-languages-and-tools.md) and the estimated time to fix it -- What's the issue and how to solve it -- The programming language and category of the issue +To [ignore or manage an issue](issues.md#ignoring-and-managing-issues), click the associated options in the menu. -Use the options in the cogwheel menu of each issue to [ignore and manage issues](issues.md#ignoring-and-managing-issues). +![Issues tab](images/{{ page.meta.file_name }}-tab-issues.png) -![New Issues and Fixed Issues tabs](images/{{ page.meta.file_name }}-tab-issues.png) +### Potential issues {: id="possible-issues"} -### Possible issues +Codacy may label some issues as **potential**, which means that the code analysis detected these issues in lines of code that weren't changed by the analyzed {{ page.meta.page_name }}. This highlights potential consequences in other parts of your codebase. -In some situations, Codacy may report either new or fixed **possible** issues on a {{ page.meta.page_name }}, which means that the code analysis detected these issues in lines of code that weren't changed by that {{ page.meta.page_name }}. This gives you awareness to how your changes may be affecting other parts of your code. - -The following are example situations that can lead to possible issues: +The following are example situations that can lead to potential issues: - The issue was either created or fixed in the current {{ page.meta.page_name }}, but the static code analysis tools reported the issue on a line that didn't change in the {{ page.meta.page_name }}. For example, if you remove the line containing the declaration of a variable you may get an "undeclared variable" issue in other lines that use that variable. -- If a file had [more than 50 issues reported by the same tool](../faq/code-analysis/does-codacy-place-limits-on-the-code-analysis.md) and you push a new commit that fixes some of these issues, Codacy will report more issues until the limit of 50 issues. These issues will be possible issues if they're outside the lines of code changed in the new commit. +- If a file had [more than 50 issues reported by the same tool](../faq/code-analysis/does-codacy-place-limits-on-the-code-analysis.md) and you push a new commit that fixes some of these issues, Codacy will report more issues until the limit of 50 issues. These issues will be potential issues if they're outside the lines of code changed in the new commit. !!! note - **If you're using GitHub** you may see [annotations](../repositories-configure/integrations/github-integration.md#issue-annotations) for possible issues reported under **Unchanged files with check annotations** on the **Files changed** tab of your pull requests. + **If you're using GitHub** you may see [annotations](../repositories-configure/integrations/github-integration.md#issue-annotations) for potential issues reported under **Unchanged files with check annotations** on the **Files changed** tab of your pull requests. + + This happens when Codacy reports potential issues in files that weren't changed in your pull request. [Read more about this GitHub feature](https://developer.github.com/changes/2019-09-06-more-check-annotations-shown-in-files-changed-tab/). - This happens when Codacy reports possible issues in files that weren't changed in your pull request. [Read more about this GitHub feature](https://developer.github.com/changes/2019-09-06-more-check-annotations-shown-in-files-changed-tab/). +## Duplication tab {: id="duplication-tabs"} -## Duplication tabs +The **Duplication** tab displays the lists of clones (duplicated code blocks) that the {{ page.meta.page_name }} adds or fixes. You can click a clone to expand it and inspect the code. -The **New Duplication** and **Fixed Duplication** tabs display the list of duplicated blocks that the {{ page.meta.page_name }} created or fixed. +![Duplication tabs](./images/{{ page.meta.file_name }}-tab-duplication.png) -![New Duplication and Fixed Duplication tabs](images/{{ page.meta.file_name }}-tab-duplication.png) +## Complexity tab + +The **Complexity** tab displays the complexity changes introduced by the {{ page.meta.page_name }}. Use the sidebar filters to filter the list by high increase (4 or more), low increase (1 to 3), or improvement (less than 0). + +!!! note + When calculating the complexity variation introduced by a {{ page.meta.page_name }}, Codacy only considers files with a high increase in complexity. For more information, see [how Codacy calculates cyclomatic complexity](../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity). + +![Complexity tab](./images/{{ page.meta.file_name }}-tab-complexity.png) + +{% + include-markdown "../repositories-coverage/commits.md" + start="" + end="" +%} ## Diff tab -The **Diff** tab displays the differences in each file that was changed in the {{ page.meta.page_name }}. The background of the changed lines depends on the change: +The **Diff** tab displays the code changes and issues introduced by the {{ page.meta.page_name }}. It includes the following areas: + +- A **list of files** modified by the {{ page.meta.page_name }}, with additional information for each file: -- **Red**: Deleted line -- **Yellow**: Old version of a changed line with deleted characters highlighted in red -- **Green**: New version of a changed line with added characters highlighted in bright green -- **Bright green**: New line + - A **green plus icon** if the file is added or a **yellow dot icon** if it's modified by the {{ page.meta.page_name }} + - The **number of new issues** introduced by the {{ page.meta.page_name }} + +- A **diff viewer** showing for each modified file the diff coverage and a comparison of the old and new file content. + + Lines with issues are highlighted according to issue severity and include a pill label with the issue type and count. Hover over the pill label to view more details or navigate to the issues. ![Diff tab](images/{{ page.meta.file_name }}-tab-diff.png) @@ -124,15 +142,13 @@ The **Diff** tab displays the differences in each file that was changed in the { The **Files** tab displays the variation of the following [code quality metrics](../faq/code-analysis/which-metrics-does-codacy-calculate.md) that the {{ page.meta.page_name }} introduces to the files in your repository, displayed either as a **positive or negative variation**, or **no variation** (represented by `=`): -- **Issues:** Number of new or fixed issues -- **Duplication:** Variation of the number of duplicated code blocks -- **Complexity:** Variation of complexity -- **Coverage variation:** Variation of code coverage percentage relative to the {% if page.meta.page_name == "commit" %}parent commit{% else %}target branch{% endif %} +- **New issues:** Number of new issues +- **Duplication:** Changes in the number of duplicated code blocks +- **Complexity:** Changes in code complexity +- **Coverage variation:** Changes in code coverage percentage compared with the {% if page.meta.page_name == "commit" %}parent commit{% else %}target branch{% endif %} Depending on the languages being analyzed or if you haven't [set up coverage for your repository](../coverage-reporter/index.md), some metrics **may not be calculated** (represented by `-`). -The option **Show files without code quality changes** allows you to list all files that the {{ page.meta.page_name }} updates, even if their code quality metrics don't change. - ![Files tab](images/{{ page.meta.file_name }}-tab-files.png) diff --git a/docs/repositories/images/commits-detail-quality-overview.png b/docs/repositories/images/commits-detail-quality-overview.png index 7f651fa150..fda2af1348 100644 Binary files a/docs/repositories/images/commits-detail-quality-overview.png and b/docs/repositories/images/commits-detail-quality-overview.png differ diff --git a/docs/repositories/images/commits-detail-status.png b/docs/repositories/images/commits-detail-status.png index d37e6d0108..641a2ca6e6 100644 Binary files a/docs/repositories/images/commits-detail-status.png and b/docs/repositories/images/commits-detail-status.png differ diff --git a/docs/repositories/images/commits-detail.png b/docs/repositories/images/commits-detail.png index 1b5c3e2efc..8943a22ee6 100644 Binary files a/docs/repositories/images/commits-detail.png and b/docs/repositories/images/commits-detail.png differ diff --git a/docs/repositories/images/commits-tab-complexity.png b/docs/repositories/images/commits-tab-complexity.png new file mode 100644 index 0000000000..29fc37dacb Binary files /dev/null and b/docs/repositories/images/commits-tab-complexity.png differ diff --git a/docs/repositories/images/commits-tab-coverage.png b/docs/repositories/images/commits-tab-coverage.png new file mode 100644 index 0000000000..3157cb1947 Binary files /dev/null and b/docs/repositories/images/commits-tab-coverage.png differ diff --git a/docs/repositories/images/commits-tab-diff.png b/docs/repositories/images/commits-tab-diff.png index bfec9dbab3..df64092b12 100644 Binary files a/docs/repositories/images/commits-tab-diff.png and b/docs/repositories/images/commits-tab-diff.png differ diff --git a/docs/repositories/images/commits-tab-duplication.png b/docs/repositories/images/commits-tab-duplication.png index 39d9bbc00c..4166a7c647 100644 Binary files a/docs/repositories/images/commits-tab-duplication.png and b/docs/repositories/images/commits-tab-duplication.png differ diff --git a/docs/repositories/images/commits-tab-files.png b/docs/repositories/images/commits-tab-files.png index c00ac2eb20..b4b37e999f 100644 Binary files a/docs/repositories/images/commits-tab-files.png and b/docs/repositories/images/commits-tab-files.png differ diff --git a/docs/repositories/images/commits-tab-issues.png b/docs/repositories/images/commits-tab-issues.png index bae3691087..0be6684e39 100644 Binary files a/docs/repositories/images/commits-tab-issues.png and b/docs/repositories/images/commits-tab-issues.png differ diff --git a/docs/repositories/images/commits.png b/docs/repositories/images/commits.png index 1472f99549..76187c1937 100644 Binary files a/docs/repositories/images/commits.png and b/docs/repositories/images/commits.png differ diff --git a/docs/repositories/images/pull-requests-detail-quality-overview.png b/docs/repositories/images/pull-requests-detail-quality-overview.png index e603c737f2..4062dda48c 100644 Binary files a/docs/repositories/images/pull-requests-detail-quality-overview.png and b/docs/repositories/images/pull-requests-detail-quality-overview.png differ diff --git a/docs/repositories/images/pull-requests-detail-status.png b/docs/repositories/images/pull-requests-detail-status.png index 52ce9c8b8c..1eb9d61f3d 100644 Binary files a/docs/repositories/images/pull-requests-detail-status.png and b/docs/repositories/images/pull-requests-detail-status.png differ diff --git a/docs/repositories/images/pull-requests-detail.png b/docs/repositories/images/pull-requests-detail.png index ab043388df..9d92c3a42b 100644 Binary files a/docs/repositories/images/pull-requests-detail.png and b/docs/repositories/images/pull-requests-detail.png differ diff --git a/docs/repositories/images/pull-requests-tab-commits.png b/docs/repositories/images/pull-requests-tab-commits.png index b8f7472c53..92c6871d03 100644 Binary files a/docs/repositories/images/pull-requests-tab-commits.png and b/docs/repositories/images/pull-requests-tab-commits.png differ diff --git a/docs/repositories/images/pull-requests-tab-complexity.png b/docs/repositories/images/pull-requests-tab-complexity.png new file mode 100644 index 0000000000..84dd8a87f9 Binary files /dev/null and b/docs/repositories/images/pull-requests-tab-complexity.png differ diff --git a/docs/repositories/images/pull-requests-tab-coverage.png b/docs/repositories/images/pull-requests-tab-coverage.png new file mode 100644 index 0000000000..6e11265add Binary files /dev/null and b/docs/repositories/images/pull-requests-tab-coverage.png differ diff --git a/docs/repositories/images/pull-requests-tab-diff.png b/docs/repositories/images/pull-requests-tab-diff.png index d083014101..af3a6a076b 100644 Binary files a/docs/repositories/images/pull-requests-tab-diff.png and b/docs/repositories/images/pull-requests-tab-diff.png differ diff --git a/docs/repositories/images/pull-requests-tab-duplication.png b/docs/repositories/images/pull-requests-tab-duplication.png index edac14f9ef..98d02d3bb6 100644 Binary files a/docs/repositories/images/pull-requests-tab-duplication.png and b/docs/repositories/images/pull-requests-tab-duplication.png differ diff --git a/docs/repositories/images/pull-requests-tab-files.png b/docs/repositories/images/pull-requests-tab-files.png index 9002aec0c1..23bca94fdd 100644 Binary files a/docs/repositories/images/pull-requests-tab-files.png and b/docs/repositories/images/pull-requests-tab-files.png differ diff --git a/docs/repositories/images/pull-requests-tab-issues.png b/docs/repositories/images/pull-requests-tab-issues.png index 355d374854..06717c0385 100644 Binary files a/docs/repositories/images/pull-requests-tab-issues.png and b/docs/repositories/images/pull-requests-tab-issues.png differ diff --git a/docs/repositories/images/pull-requests.png b/docs/repositories/images/pull-requests.png index da37112666..6f6d2f5677 100644 Binary files a/docs/repositories/images/pull-requests.png and b/docs/repositories/images/pull-requests.png differ diff --git a/docs/repositories/issues.md b/docs/repositories/issues.md index 715a2d5b0d..cb2c924395 100644 --- a/docs/repositories/issues.md +++ b/docs/repositories/issues.md @@ -9,12 +9,14 @@ By default, the page lists the issues on the main branch of your repository but ![Issues page](images/issues.png) + Click the title of an issue to see the following information: - The committer and date of the commit that introduced the issue, if available - The estimated time to fix the issue - What the issue is and how to solve it - The [tool that reported the issue](../getting-started/supported-languages-and-tools.md) and the related code pattern + ![Issue details](images/issues-detail.png) @@ -55,8 +57,6 @@ You can define one or more of the following filters: Use the options in the menu of each issue to: -- **Copy the link** to the issue. - - **Ignore the issue** and hide it from the list. Codacy will no longer report the issue after the next analysis of your repository. For example, you can ignore issues that you disagree with because: diff --git a/docs/repositories/pull-requests.md b/docs/repositories/pull-requests.md index 55ec09daca..f530e531ca 100644 --- a/docs/repositories/pull-requests.md +++ b/docs/repositories/pull-requests.md @@ -7,7 +7,7 @@ file_name: "pull-requests" 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. -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. +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. ![Pull Requests page](images/pull-requests.png) @@ -19,11 +19,11 @@ The next sections describe each area of the pull request detail page. ## Pull request status {: id="status"} -This area displays the information that identifies the pull request (head and base branches, date, and name), as well as: +This area displays the information that identifies the pull request (name, author, head and base branches, and last updated date), as well as: -- The analysis status and a [button to reanalyze the last commit on the pull request branch](../faq/repositories/how-do-i-reanalyze-my-repository.md) (enabled when the committer [is part of your organization](../organizations/managing-people.md)) -- A link to the analysis logs - A link to the pull request on your Git provider +- A [link to reanalyze the latest pull request commit](../faq/repositories/how-do-i-reanalyze-my-repository.md), present when the committer [is part of your organization](../organizations/managing-people.md) +- A link to the analysis logs ![Pull request status](images/pull-requests-detail-status.png) @@ -41,7 +41,7 @@ This area displays the information that identifies the pull request (head and ba ## Commits tab -The **Commits** tab displays an overview of each commit included in the pull request, such as the analysis status and the number of new and fixed issues for each commit. +The **Commits** tab displays an overview of each commit included in the pull request, such as the analysis status and the number of issues introduced. Click a specific commit to see [detailed information about that commit](commits.md#status).