Adding Your First Repo

Code Climate helps your team ship better code, faster, by incorporating fully-configurable static analysis and test coverage data into your development workflow.

Deep integration with pull request workflows immediately increases the visibility of code quality throughout your organization and gives your team the information they need to improve code quality with every commit.

Improved code quality means better maintainability, increased test coverage, fewer bugs, and more efficient code reviews – all of which make for a happier, more productive team.

To get started, head to codeclimate.com and Sign Up via GitHub. Signing up with GitHub authentication links your Code Climate user with your GitHub user, making it easier to add your repositories and to take advantage of our awesome GitHub Pull Request integration.

Once authenticated, you’ll land on your Code Climate dashboard. From here you can add your first repo. Note: the repository must be owned or administered by your GitHub user.

To add a private repo, click the button to Start 14-Day Free Trial.

You’ll then see a list of all your GitHub organizations (don't see your organization?). Click the Add button next to your organization to create a Code Climate organization named after your GitHub organization. If you don't see your org GitHub org listed, head here for troubleshooting steps.

Once you've created your trial Code Climate org, you'll land on your organization dashboard. From here, click the button to Add a Repository.

Want to analyze an Open Source repo?

Check out our guide to Managing Open Source Repos.

You’ll see a Build page displaying the progress of each analysis engine running on your code.

Once your first build has completed, click Continue to the Results. This takes you to the Issues page, which lists all of the issues that Code Climate has found in your default branch. Issues can be filtered by category, engine, and/or severity. You can click on the link below an issue to drill down into the details of that specific listing.


What's Next

Now that you’ve added Code Climate to your repo, we recommend configuring the analysis to meet your team's standards. You can also choose to skip ahead to our test coverage integration.

Configuring Your Analysis
Setting Up Test Coverage
Introducing Code Climate to Your Team
Adding Code Climate to Your Workflow