feat: new Coverage and overview metrics#2590
Conversation
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>
|
Overall readability score: 54.18 (🟢 +0.06)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Codacy's Analysis Summary0 new issue (≤ 0 minor issue) Review Pull Request in Codacy →
|
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>
There was a problem hiding this comment.
Pull Request Overview
The pull request is well-structured and follows the project's quality standards. No blocking security or logical issues were found. Suggestions are provided to enhance the clarity of the metric descriptions and maintain document consistency.
Test plan proposal
- Verify that the average grade calculation on the 'Grade' tab correctly processes exactly the 100 most recently updated repositories.
- Confirm that the 'Complexity' section highlighting logic correctly reflects the goals defined at the repository level.
- Validate that 'Coverage' for paid plans is calculated as a line-based aggregate (sum of covered / sum of coverable) rather than an average of individual repository percentages.
- Ensure the 'Duplication' distribution correctly categorizes repositories that have no configured quality goals.
About this PR
- The pull request title is missing a Jira issue key. Consider updating it to follow the format:
feat: [JIRA-123] new Coverage and overview metrics.
🗒️ Improve review quality by adding custom instructions.
💡 Codacy uses AI. Check for mistakes.
|
|
||
| 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. |
There was a problem hiding this comment.
🟡 MEDIUM RISK
This sentence contradicts the definition provided a few lines above. If a file is 'below goal', it should not be categorized as 'complex' according to the criteria on line 98.
This might be a simple fix:
| 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. | |
| At the bottom of the tab, the file distribution helps you understand which files are above goal, below goal, or in repositories without a goal. Files are not filterable, while repository goal distributions are. |
|
|
||
| In this tab, you can understand your organization's complexity status (based on the number of complex files) and how repositories compare against their [goals](../../repositories-configure/adjusting-quality-goals.md). A file is considered complex if its cyclomatic complexity value is higher than the goal defined at repository level. To learn more, see [how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity). | ||
|
|
||
| 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. |
There was a problem hiding this comment.
⚪ LOW RISK
Suggestion: The current phrasing is a bit informal. Improving the tone enhances the professional quality of the documentation.
Try running the following prompt in your IDE agent:
Rephrase the sentence to be more professional and technically precise: '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. | ||
|
|
||
| ## Duplication | ||
|  |
There was a problem hiding this comment.
⚪ LOW RISK
Nitpick: Maintaining consistent spacing between headers and assets improves document readability and follows the pattern established in the previous sections.
This might be a simple fix:
|  | |
| ## Duplication | |
|  |
👀 Live preview
https://coverage-and-overview-metrics--docs-codacy.netlify.app/organizations/reporting/organization-overview/
🚧 To do
Test plan proposal