Skip to content

Update cov tab image #2598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mark-rln wants to merge 2 commits into from
Closed

Update cov tab image #2598

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f7fb84
add missing coverage tab section
Feb 24, 2026
21bcc54
Merge branch 'master' of https://github.com/codacy/docs
Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/repositories/pull-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,29 @@
end="<!--tabs-end-->"
%}

## Coverage tab

The Coverage tab provides a detailed breakdown of how your changes impact the project's test coverage. It allows you to ensure that new code is properly tested before it is merged.

Check failure on line 44 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 44, "column": 168}}}, "severity": "ERROR"}

Check warning on line 44 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Adverbs] Consider removing 'properly'.

Raw Output:
{"message": "[Microsoft.Adverbs] Consider removing 'properly'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 44, "column": 145}}}, "severity": "WARNING"}

Check failure on line 44 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'it's' instead of 'it is'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'it's' instead of 'it is'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 44, "column": 168}}}, "severity": "ERROR"}

Check warning on line 44 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Adverbs] Consider removing 'properly'.

Raw Output:
{"message": "[Microsoft.Adverbs] Consider removing 'properly'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 44, "column": 145}}}, "severity": "WARNING"}

**Coverage Overview**
At the top of the tab, two primary indicators give you an immediate health check of the Pull Request:

* **Diff Coverage**: The percentage of new or modified executable lines that are covered by tests.
* **Coverage Variation**: The net impact (increase or decrease) the PR has on the overall project coverage percentage.

Comment on lines +47 to +51
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

List items in this new section use * and a single space, but the repo's markdownlint config enforces dash-style lists and spacing (MD004 style "dash" and MD030/MD007). Please switch these bullets to - with the expected spacing so linting passes consistently.

Copilot uses AI. Check for mistakes.
**File Breakdown**
On the left sidebar, you can find a list of all files modified in the PR. For each file, Codacy displays its specific diff coverage percentage, helping you quickly identify which parts of your contribution might be missing tests.

Check warning on line 53 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Adverbs] Consider removing 'quickly'.

Raw Output:
{"message": "[Microsoft.Adverbs] Consider removing 'quickly'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 53, "column": 157}}}, "severity": "WARNING"}

Check warning on line 53 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Adverbs] Consider removing 'quickly'.

Raw Output:
{"message": "[Microsoft.Adverbs] Consider removing 'quickly'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 53, "column": 157}}}, "severity": "WARNING"}

**Diff Visualization**
The main view displays the code changes with a specialized coverage overlay to pinpoint exactly what is being tested:

Check failure on line 56 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'what's' instead of 'what is'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'what's' instead of 'what is'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 56, "column": 97}}}, "severity": "ERROR"}

Check failure on line 56 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'what's' instead of 'what is'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'what's' instead of 'what is'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 56, "column": 97}}}, "severity": "ERROR"}

* **Covered Lines (Green)**: Lines executed by your test suite. These are marked with a green highlight and a label indicating the number of hits (e.g., 1 hits), representing how many times that line was executed during the test run.

Check failure on line 58 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 58, "column": 148}}}, "severity": "ERROR"}

Check failure on line 58 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.

Raw Output:
{"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.,'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 58, "column": 148}}}, "severity": "ERROR"}
Comment on lines +47 to +58
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor wording/grammar: "Pull Request" is capitalized inconsistently with the rest of the page, and the example "1 hits" should be singular ("1 hit"). Please adjust the capitalization and the example text for correctness.

Copilot uses AI. Check for mistakes.
* **Uncovered Lines (Red)**: Executable lines that were not reached by any tests. These are marked with a red highlight and a Not covered label.

Check failure on line 59 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'weren't' instead of 'were not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'weren't' instead of 'were not'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 59, "column": 52}}}, "severity": "ERROR"}

Check failure on line 59 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'weren't' instead of 'were not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'weren't' instead of 'were not'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 59, "column": 52}}}, "severity": "ERROR"}

Comment on lines +55 to +60
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same markdownlint issue here: these list items use * instead of - and don't match the configured list marker spacing. Updating them to dash-style bullets with the repo-standard spacing should prevent lint failures.

Copilot uses AI. Check for mistakes.
*Note: Lines that are not executable (like comments or empty lines) will not show a coverage status.*

Check failure on line 61 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'won't' instead of 'will not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'won't' instead of 'will not'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 61, "column": 69}}}, "severity": "ERROR"}

Check failure on line 61 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 61, "column": 19}}}, "severity": "ERROR"}

Check failure on line 61 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'won't' instead of 'will not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'won't' instead of 'will not'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 61, "column": 69}}}, "severity": "ERROR"}

Check failure on line 61 in docs/repositories/pull-requests.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'aren't' instead of 'are not'.", "location": {"path": "docs/repositories/pull-requests.md", "range": {"start": {"line": 61, "column": 19}}}, "severity": "ERROR"}

![Commits tab](images/pull-requests-tab-coverage.png)
Copy link

Copilot AI Feb 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The image alt text says "Commits tab" but this screenshot is for the Coverage tab. Please update the alt text to match the actual content for accessibility and to avoid confusing readers.

Suggested change
![Commits tab](images/pull-requests-tab-coverage.png)
![Coverage tab](images/pull-requests-tab-coverage.png)

Copilot uses AI. Check for mistakes.

## 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 issues introduced.
Expand Down
Loading