Giter VIP home page Giter VIP logo

codeclimate-test-repo's Introduction

Codeclimate Test Repo

Playground to test out automated code quality / linting comments on fellow work.

Set up PR comments with Codeclimate

This has been done for the test repo, but you'll need to take these steps in the Code Climate UI for any other repos to enable GitHub PR comments.

Code Climate's documentation for this is here

The manual setup is laborious on a per repo basis but Pursuit has ~1,000 repos so we can't give Code Climate blanket authorization. In the future we can try to use the Code Climate API to automate these steps.

Sign up / Log in

  1. Go to the Code Climate site
  2. Choose Login > Quality
  3. Use your GitHub account to sign up or log in
  4. Choose the Open Source organization (or joinpursuit if that is an option)
  5. This should take you to a dashboard screen that lists Repositories

Adding the repo

  1. Make sure your repo is public.
  2. Click Add a repository
  3. After Code Climate has synced the GH repos you're associated with, scroll down and find the repo you want to add. Click Add Repo.
  4. You'll see Code Climate do some build steps that should take ~2 minutes
  5. When the success modal appears, click See Results to go to the repo view. The view for this repo is here. Troubleshooting
  • Your repo may need to be public.
  • Code Climate's idea of alphabetical order is A-Z, then a-z

Configuring GitHub PR comments

  1. Choose the Repo Settings tab
  2. Choose GitHub on the left menu.
  3. Click Pull request comments > Set up
  4. Go through the Oauth flow to authorize Codeclimate:
  5. Choose the Pursuit org
  6. Important Choose Only select repositories and select your repo, then click Install
  7. You'll be dumped on github.com so you'll need to navigate back to the Repo Settings > GitHub UI on Code Climate
  8. Flip on the toggle for Inline issue comments
  9. Set maximum number of comments per issue to your desired number (5 is the default; this repo is set to 10)
  10. Hit Save
  11. This repo also has Pull request status updates installed. I am not sure if this is a requirement in order to get the inline PR comments.

Verifying

  1. Open a PR against your repo
  2. You should see the Code Climate check running (if you installed Pull request status updates)
  3. If any of the files you touched have Code Climate errors or eslint errors, you should see inline commments. Example PR with comments

codeclimate-test-repo's People

Contributors

mikeboyle avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.