Skip to content

Commit de77f35

Browse files
committed
add org level metric definitions
1 parent 5a70702 commit de77f35

1 file changed

Lines changed: 11 additions & 15 deletions

File tree

docs/organizations/reporting/organization-overview.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Some of these metrics depend on your billing plan and are calculated differently
6060
!!! important
6161
- The **Code health and security** area calculates metrics and displays data only for the **repositories that you follow** on Codacy. This means that depending on their list of followed repositories, two users can see different results on this chart.
6262

63-
- Metrics like grade, complexity, duplication, and coverage (on free plans) represent **at most the last 100 updated repositories**.
63+
- Some organization-level metrics are limited to the latest 100 updated repositories, depending on the metric and your plan.
6464

6565
<sup><span id="coverage-note">1</span></sup>: Coverage metrics are calculated differently for paid plans and for open source and trial plans. [Learn more](#coverage).
6666

@@ -83,52 +83,48 @@ The **Last updated repositories** list displays the last updated repositories, s
8383

8484
The **Grade** tab gives you visibility into grade distribution across your repositories. From this tab, you can identify the repositories with the highest risk by selecting a grade in the distribution chart.
8585

86-
To learn more about how grades are calculated [see how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade).
86+
At organization level, **Grade** is the average grade across your latest 100 updated repositories.
8787

88-
!!! important
89-
Grade metrics are based **at most on the last 100 updated repositories**.
88+
To learn more about how grades are calculated [see how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade).
9089

9190
## Complexity
9291

9392
![Image of the Complexity tab](./images/organization-overview-complexity.png)
9493

9594
Complexity allows you to understand which repositories are at risk of having code that is more difficult to test and more likely to have defects.
9695

96+
At organization level, **Complexity** is the percentage of complex files across your latest 100 updated repositories.
97+
9798
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).
9899

99100
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.
100101

101102
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.
102103

103-
!!! important
104-
Complexity metrics are based **at most on the last 100 updated repositories**.
105-
106104
## Duplication
107105
![Image of the Duplication tab](./images/organization-overview-duplication.png)
108106

109107
Duplication allows you to check if sequences of duplicate code exist in at least two different places of the source code of your repository.
110108

109+
At organization level, **Duplication** is the average duplication across your latest 100 updated repositories.
110+
111111
In this tab, you can see your average duplication and check which repositories are above goal, below goal, or without configured [goals](../../repositories-configure/adjusting-quality-goals.md).
112112

113113
To learn more about duplication metrics, see [how duplication is calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication).
114114

115-
!!! important
116-
Duplication metrics are based **at most on the last 100 updated repositories**.
117-
118115

119116
## Coverage
120117

121118
![Image of the Coverage tab](./images/organization-overview-coverage.png)
122119

123120
The **Coverage** tab provides organization-level visibility into your coverage status. Strong coverage helps protect your code and reduce the risk of regressions when code changes.
124121

125-
!!! important
126-
The Coverage tab has two modes:
122+
At organization level, **Coverage** depends on your plan:
127123

128-
- On trial and open source plans, you can see the average repository coverage across the 100 most recently updated repositories. This includes visibility into which repositories are above goal, below goal, or without a goal, similar to the Duplication and Complexity tabs.
129-
- On paid plans, the dashboard removes the 100-repository limitation and provides additional metrics to help you prioritize improvements. This is the mode covered in this page.
124+
- On trial and open source plans, it is the average coverage across your latest 100 updated repositories.
125+
- On paid plans, it is a line-based percentage calculated as `coveredLines / coverableLines` across repositories reporting coverage.
130126

131-
To understand better how these metrics are calculated, [learn more](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage).
127+
To understand better how these metrics are calculated, [learn more](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage).
132128

133129
The Coverage tab is based on two key metrics:
134130

0 commit comments

Comments
 (0)