Project Dashboard - How does it work?

On your Project Dashboard you can see an overview of the project and check for attention points that we select for you on relevant items that require your intervention. See below a full description of this dashboard and all the functionalities behind it!

 


How does it look like?

On the Project Dashboard you can find two main sections: the project view of a specific branch (on the left side (in white) and the main branch summary view on the right side (in grey). Overall you will find 3 main sections on the branch specific section: 1 Quality evolution Chart, 2 Issues breakdown, 3 Coverage status; and on the main branch section: 4 Hotspots5 Logs and 6 Pull requests status sections. 

 

Screen_Shot_2018-05-03_at_22.33.18.png

 


How can I access the Project Dashboard?

You can access the Project Dashboard by selecting on the Organization Dashboard a specific project, or by trying to access a project url for any part of our platform. 

On the Project Dashboard you can select which branch you want to see details for. You can do this by selecting (or searching on the search bar) for a specific branch, next to the name of the project:

Screen_Shot_2018-05-03_at_22.38.33.png

At any given moment in time, you can go back to your Organization view by clicking on "Team" on the left navigation sidebar. Or you can navigate to all the different menu options available on the project view: Commits, Files, Issues, Pull Requests, Security, Code Patterns and Settings. If you click "Dashboard" at this level, you will always go back to the Project Dashboard view.

Screen_Shot_2018-05-03_at_22.40.11.png

 

 


What are the functionalities available?

1. Project certification and Quality evolution 

Here you can see the grade of the project, and you can see the quality evolution of the project on the Quality evolution Chart. On the chart you can select to see results for the "Last 7 days", for the "Last 31 days" or for the "Last 8 commits" if you don't have data from the last 31 days. 

Screen_Shot_2018-05-03_at_22.44.22.png

You can see, per criterium (Issues, Complex Files, Duplicated code and Coverage), how the project is behaving on the last x days. You can navigate on the different criterium by clicking on the tabs of the chart.

You can also see, the trend for the next 31 days (assuming the past behaviour), the pull request prediction (the changes caused by open pull requests if they are not changed) and the quality standard (defined on the project settings).

In the example you see "Issues" with a red indication Screen_Shot_2018-05-03_at_22.51.02.png this means that the number of Issues is above what was defined on the quality standards. Also we can see next to each criterium a delta (can be "=", a drop or an increase), representing the changes observed in the period selected. In the example, there was no change of number of Issues on the last 31 days, however there was a decrease of 160% of duplicated code.

You should be aware that for Issues/Complex Files/Duplicated code (the more we have it, the worse we are), being above of the defined standards is considered bad, so the indication will be Screen_Shot_2018-05-03_at_22.51.02.pngwhereas for Coverage (the more we have it, the better we are), being above of the defined standards will be flagged with Screen_Shot_2018-05-03_at_22.55.26.png.

For the case when you don't have recent data, we will display by default an option on your graph - "Last 8 commits", and we display the quality evolution (and all the other metrics) for your last 8 commits analysed on Codacy.

2. Issues breakdown

Here you can see the total of issues on the branch selected and the total lines of code (total LoC). Additionally, you will be able to see a breakdown of the issues found per category of issue. By clicking on the name of the category or on the total per category of issues you will be directed to the list of issues filtered by that category.

Screen_Shot_2018-05-03_at_23.01.53.png

You can also click on "See all issues" and go to the list of issues without any category selected. In case you don't have issues this component will display 0 issues (in the total and in all categories).

3. Coverage status

On this component of the Project Dashboard you will be able to see: the number of files without coverage, the number of files with coverage not up to standards based on your quality settings (defined at project level) and the number of files with coverage up to standards based on you quality settings. If you click on "See all files" you will go to the list of files.

Screen_Shot_2018-05-22_at_20.28.50.png

In case you don't have coverage set up for this project we will let you know on this component, and you can click on "Set up your coverage here" (in case you have write permission on the Project) and go to the project settings to configure set up coverage.

4. Hotspots

You have a section of relevant items that require attention on the Project. On this section you can see a set of attention points, you can click on them or dismiss them, in case you don't feel they are relevant. We have created a full article on this, so that you can learn more about it.

5. Logs

You have a section of relevant activities that happened on the project you selected. We have created a full article on this, so that you can learn more about it.

6. Pull requests status

Under this section you will be able to see a display of all open pull requests for this project and their split between "Not up to standards", "Up to standards" and "Analysis failed". If you click on "See all pull requests" you go to the Pull requests page for that project. 

 

 

Screen_Shot_2018-05-03_at_23.08.42.png  

 


We would love your feedback, in case you want to let us know what you think about the Project Dashboard, how it could be improved, etc feel free to reach out or leave a comment!

 

 

 

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.