Skip to content

Comments

feat: new Coverage and overview metrics#2590

Open
claudiacodacy wants to merge 30 commits intomasterfrom
coverage-and-overview-metrics
Open

feat: new Coverage and overview metrics#2590
claudiacodacy wants to merge 30 commits intomasterfrom
coverage-and-overview-metrics

Conversation

@claudiacodacy
Copy link
Contributor

@claudiacodacy claudiacodacy commented Feb 20, 2026

👀 Live preview

https://coverage-and-overview-metrics--docs-codacy.netlify.app/organizations/reporting/organization-overview/

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

Test plan proposal

  • Verify that all internal anchor links (e.g., #grade, #coverage, #overview-filters) resolve to the correct sections on the rendered page
  • Confirm the Markdown tables in the 'Code health and security' and 'Coverage' sections render correctly without layout shifts or broken rows
  • Validate that all newly referenced images (e.g., organization-overview-grade.png) exist in the repository and display correctly
  • Check that external links to GitLab and Bitbucket documentation are functional and lead to the correct API references

claudiacodacy and others added 25 commits February 19, 2026 16:18
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
@claudiacodacy claudiacodacy requested a review from a team as a code owner February 20, 2026 14:45
@github-actions github-actions bot temporarily deployed to Netlify February 20, 2026 14:45 Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Feb 20, 2026

Overall readability score: 54.18 (🟢 +0.06)

File Readability
organization-overview.md 62.86 (🟢 +14.43)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
organization-overview.md 62.86 38.92 8.72 11.7 12.58 6.4
  🟢 +14.43 🟢 +5.78 🟢 +3.04 🟢 +2.7 🟢 +0.59 🟢 +1.09

Averages:

  Readability FRE GF ARI CLI DCRS
Average 54.18 43.04 10.94 12.32 12.22 8.01
  🟢 +0.06 🟢 +0.02 🟢 +0.01 🟢 +0.01 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@codacy-production
Copy link
Contributor

codacy-production bot commented Feb 20, 2026

Codacy's Analysis Summary

0 new issue (≤ 0 minor issue)
0 new security issue

Review Pull Request in Codacy →

AI Reviewer available: add the codacy-review label to get contextual insights without leaving GitHub.

codacy-production[bot]

This comment was marked as outdated.

Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
@github-actions github-actions bot temporarily deployed to Netlify February 20, 2026 14:51 Inactive
codacy-production[bot]

This comment was marked as outdated.

@github-actions github-actions bot temporarily deployed to Netlify February 20, 2026 14:54 Inactive
codacy-production[bot]

This comment was marked as outdated.

claudiacodacy and others added 2 commits February 20, 2026 15:01
Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com>
@github-actions github-actions bot temporarily deployed to Netlify February 20, 2026 15:03 Inactive
codacy-production[bot]

This comment was marked as outdated.

Copy link
Contributor

@codacy-production codacy-production bot left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

The pull request is up to standards based on static analysis. It successfully updates the Organization Overview documentation to reflect new metrics and layout changes. I have identified a few technical inconsistencies in the metric descriptions and link behaviors that should be addressed to ensure documentation accuracy.

Test plan proposal

  • Verify that internal anchors (#grade, #complexity, #duplication, #coverage) correctly navigate to the intended sections when clicked from the tabs list.
  • Confirm that the 'Coverage' metric description in the summary table (line 138) aligns with the product behavior for users on Trial/OSS vs Paid plans.
  • Ensure the Markdown table at line 50 renders correctly in various viewport widths, specifically checking that the embedded HTML links and superscripts do not cause column misalignment.
  • Validate that all external links to GitLab and Bitbucket API documentation open in a new browser tab/window consistently.

About this PR

  • The Jira issue key is missing from the PR title and the corresponding task in the checklist is unchecked. If this PR is linked to a specific ticket, please update the title (e.g., 'feat(ORG-123): new Coverage and overview metrics').

🗒️ Improve review quality by adding custom instructions.
💡 Codacy uses AI. Check for mistakes.


| Metric | Description |
| ------ | ----------- |
| **Coverage** | `coveredLines / coverableLines` <br/>Aggregation of all covered lines divided by all coverable lines across all repositories (or your filter selection, see [filters](#overview-filters)). This metric only includes repositories reporting coverage. |
Copy link
Contributor

Choose a reason for hiding this comment

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

🟡 MEDIUM RISK

The description for the 'Coverage' metric in this table only covers the calculation for Paid plans. To avoid misleading users on other plans, it should reflect the 'Average' calculation mentioned in the previous section.

Try running the following prompt in your IDE agent:

Update the 'Coverage' row in the table at line 138 of docs/organizations/reporting/organization-overview.md to mention that the calculation is plan-dependent (Aggregation for Paid plans vs Average for Trial/OSS plans), referencing the specific logic described in lines 124-125.


This panel shows, from the top 100 most recently updated repositories, which repositories are above goal, below goal, or have no goal. Because complexity is better when lower, repositories above goal are highlighted so you can review and act on them.

At the bottom of the tab, the complex files distribution helps you understand which files are complex because they are above goal, below goal, or in repositories without a goal. Files are not filterable, while repository goal distributions are.
Copy link
Contributor

Choose a reason for hiding this comment

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

🟡 MEDIUM RISK

This sentence implies that files below the goal are considered complex, which contradicts the definition provided earlier. If the chart displays the total file distribution, the phrasing should be adjusted.

This might be a simple fix:

Suggested change
At the bottom of the tab, the complex files distribution helps you understand which files are complex because they are above goal, below goal, or in repositories without a goal. Files are not filterable, while repository goal distributions are.
102 | At the bottom of the tab, the file distribution helps you understand the status of your files relative to their goals (above goal, below goal, or in repositories without a goal).

Comment on lines 77 to 78
- **GitLab:** date when the project was last updated (value of `last_activity_at` from the [GitLab Groups API](https://docs.gitlab.com/ee/api/groups.html)). Note that this value is only updated [at most once per hour](https://gitlab.com/gitlab-org/gitlab/-/issues/20952)).
- **Bitbucket:** date when the repository was last updated (value of `updated_on` from the [Bitbucket Repositories API](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-group-repositories)). **On Bitbucket Server** Codacy can't obtain this information and the list displays the repositories in alphabetical order.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚪ LOW RISK

Suggestion: For consistency with the GitHub link above, please add the target attribute to these external API links.

This might be a simple fix:

Suggested change
- **GitLab:** date when the project was last updated (value of `last_activity_at` from the [GitLab Groups API](https://docs.gitlab.com/ee/api/groups.html)). Note that this value is only updated [at most once per hour](https://gitlab.com/gitlab-org/gitlab/-/issues/20952)).
- **Bitbucket:** date when the repository was last updated (value of `updated_on` from the [Bitbucket Repositories API](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-group-repositories)). **On Bitbucket Server** Codacy can't obtain this information and the list displays the repositories in alphabetical order.
77 | - **GitLab:** date when the project was last updated (value of `last_activity_at` from the [GitLab Groups API](https://docs.gitlab.com/ee/api/groups.html){: target="_blank"}). Note that this value is only updated [at most once per hour](https://gitlab.com/gitlab-org/gitlab/-/issues/20952){: target="_blank"}).
78 | - **Bitbucket:** date when the repository was last updated (value of `updated_on` from the [Bitbucket Repositories API](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-repositories/#api-group-repositories){: target="_blank"}). **On Bitbucket Server** Codacy can't obtain this information and the list displays the repositories in alphabetical order.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant