codebeat

Advice & answers from the codebeat team

New to codebeat? Want to learn more about our tool or how it can help you developer better code? You're in the right place! Go ahead and browse our documentation; you should find all the answers there.

You can also reach us directly through the live chat icon placed in the bottom right-hand corner.

How to read a codebeat report

A codebeat project report consists of four main parts: a graph with project historical details, a tab with recent changes, a tab with Quick Wins and a tab with the list of namespaces for further investigation.

Project graph

First thing you will notice in a codebeat report is a section with overall GPA and a graph with historical data (if your project is at least 3 days old). The smiley on the left represents the overall GPA mapped to one of five grades: A (dark blue), B (light blue), C (yellow), D (orange) and F (red). On the right hand side you can see a distribution wheel where colored slices of the wheel represent the number of namespaces in a project with a given grade.

Recent Changes

Below the report you can see the Recent Changes section which shows important things that happened to your project since you started tracking it. For a new project the only event you will be able to see is the project creation event but as you introduce changes to your project this section will populate with a lot of helpful information. Some project events will contain links to their relevant classes. Those that don't represent namespaces that were since removed from the project.

Diffs on quality changes

When you hover over most project events you will see a Compare Changes button. Clicking in will load an inline diff showing what exactly changed in a namespace that caused a given event to be triggered.

Quick Wins

Quick Wins represents issues that - when addressed - are likely to cause the largest GPA boost. You can read more about it here.

List of namespaces

Last tab on the left shows a full list of namespaces in a project, which can be ordered by rating, name, complexity, number of issues and number of code duplications. Each entry contains a link to the relevant namespace view.

How to read a codebeat report