The Breakdown section of a repository's Overview page displays the number of files in the repo being analyzed by Code Climate.
The Ratings bar maps colors to letter grades. The amount of real-estate given to any given color indicates how prevalent the letter grade is in the repository.
The Test Coverage bar visualizes the percentage of the repository's code which is covered by tests.
A repository's GPA is displayed on the Overview page.
Hovering over the GPA maps colors to letter grades. The amount of real-estate given to any given color indicates how prevalent the letter grade is in the repository.
If your repository has not received grades for your individual files or an overall GPA, check to make sure that you've specified a
ratings path in your
.codeclimate.yml. More information can be found in our Ratings doc.
To the right of the GPA, you'll see the number of issues that Code Climate has found in your default branch.
If you've set up test coverage, the overall percentage of your default branch currently covered by your testing suite will be displayed next to the number of issues.
To learn more about how to get our Test Coverage feature set up, check out our help doc!
You can always check to see when Code Climate last analyzed your repository, by looking in the top-right corner of the Feed page for a SHA value. This is the SHA associated with the most recent commit to your default branch analyzed by Code Climate.
Next to the SHA is a "refresh" button, which enables you to manually trigger a new analysis. If you find yourself triggering an analysis manually on a regular basis, that may be sign that a deeper problem exists. To troubleshoot, we first recommend checking to make sure that our webhook is installed. If the problem persists, please contact support.
Want to show off your repository's maintainability rating or test coverage percentage?
- Head to your repo's Settings page:
- Click on the Badges link:
- Select the format of your choice.
For repos added before July 2017, you can access the Badges page by appending
/badges to the end of your repo's Code Climate URL.
- Go to your repo's Code Climate page:
/badgesto the end, like this:
You can track Feed updates via an RSS reader. To view your Feed's RSS URL, click the button at the bottom left of the page.
Your RSS URL contains a secret token. Anyone with the URL can view your Feed