Skip to main content

Add a Code Quality Badge

Add Quality Badges

A badge displays your code quality on a public webpage, such as your GitHub README file.

Go to Code Analysis, click on your project, then click on the Preferences tab, click on General Information and copy and paste the Badge URL where you want to show this as your quality score. You can also add a badge on your project page to show the code grade (as shown below).

Project preferences

Show the Code Quality Score

The Code Quality Score is a value from 0 to 100 that reflects the quality of your code base.

Example of badge

To add it, just insert the following code snippet in the README.md file at your project root (replace <PROJECT_IDENTIFIER> with the project identifier).

[![Code Grade](https://api.codiga.io/project/<PROJECT_IDENTIFIER>/score/svg)](https://www.codiga.io)

Hint: you can find the full URL to use in your project preferences.

Show the Code Grade

The Code Grade is a score from A (best quality) to F (worst quality) for your code base.

Example of badge

Insert the following code snippet in the README.md file at your project root (replace <PROJECT_IDENTIFIER> with the project identifier).

[![Code Grade](https://api.codiga.io/project/<PROJECT_IDENTIFIER>/status/svg)](https://www.codiga.io)

Hint: you can find the full URL to use in your project preferences.