Dashboard

1. Introduction


The Dashboard is the central screen of any project on Codacy. After Codacy has cloned the project and run the first analysis, data will populate the dashboard and help you answer two main questions on your project:

  • what is the current state of the repository's code quality?
  • how is it evolving through time?

The dashboard gives metrics on a per-branch basis. To change the branch just click on the arrow next to the branch name and select the branch you want to see.

 


Change the branch of your Codacy Dashboard

If you can't see the desired branch please enable the analysis on that branch.

 

2. Project Certification


After running the first analysis on the project, Codacy will give an overall grade from A to F to the branch, and grade different quality categories:

  • Error Prone
  • Code Complexity
  • Code Style
  • Unused Code
  • Security
  • Compatibility
  • Documentation
  • Performance

Each of those categories is graded according to the code patterns run on the project as each pattern enters in a specific category. To learn more about the meaning of these categories go to this page.


This helps you discover the areas that you should focus on.

To learn more about how the grades are calculated, go to the Grades Page.


The project certification in your Codacy Dashboard

 

3. Issues Breakdown


The issues breakdown gives you a quick overview of the total number of issues in your repository and the breakdown per category.

Click on a category to see a list of all the issues in that category.

 


Issues Breakdown on the Dashboard

4. Code Coverage


If you setup the code coverage on your repository, you will be able to see the overall coverage percentage on the dashboard. It will also show the files with the worst code coverage allowing you to directly jump to them to see the details.


Code Coverage on the Dashboard

 

5. Goals to improve


The goals to improve area will show a selection of two goals that you added to your project.

6. Historical data


Understand how the quality of your project evolved throughout time regarding issues, severity, churn, overall project quality and test coverage. Codacy will show you the evolution for the last 20 commits.

Issues

Evolution of the number of issues per category.


 

Severity

Follow the evolution of issues per severity level. Codacy currently has three levels of severity: Info, Warning, and Error. You can learn more about these levels here.

 


 

Project Quality

Follow the evolution of the number of files per grade.


 

Churn/Complexity

Drill down in the files that have the highest churn and complexity ratio and find "hot spots" that need your attention. Churn is the number of times a file is changed. Research has shown that there might be a link between churn and system failures.

 

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.