Badges are used to represent the high-level project status and its stability to the users coming to your repository or website. Since Codacy can show the quality of your code, it is definitely something you may want to display on your repository in the README.MD file.
Let's perform the following steps to add a Codacy badge to your GitHub repository:
- Log in to https://app.codacy.com, which will bring you to your Organization Dashboard.
- Click on Projects on the left menu.
- Select a project to analyze.
- Click on the Badge icon next to your project name:
- Click on Add badge to repository to create a Pull Request (PR) to your repository:
- Review the content of the PR and merge it. Once it's been merged, you will see the code quality score on your repository Overview page, similar to what's shown in the following screenshot:
Badges are used to highlight important tests and information for your repository visitors.