vast icon indicating copy to clipboard operation
vast copied to clipboard

Add code climate reporting for style and coverage

Open careyrp opened this issue 5 years ago • 0 comments

Add Code Climate for reporting code quality of pull requests to the vast project. Code Climate is free to use for public open-source projects.

@chrisdinn this will require you to set up a code climate account. The following are instructions for setting up code climate. This setup must be completed before merging this pull request.

I recommend signing up to Code Climate using your GitHub account. This will make setup easier. You won't have to link your code climate, and Github accounts later. https://codeclimate.com/login/github/join

Add the vast repo to code climate. Open Source Repos are free in Code Climate. https://codeclimate.com/github/repos/new

From https://codeclimate.com/github/chrisdinn/vast Go to Repo Settings -> GitHub Turn on Summary comments and/or Inline issue comments Install Webhook on GitHub

From https://codeclimate.com/github/chrisdinn/vast Go to Repo Settings -> Test coverage Copy the <TEST REPORTER ID> Go to https://travis-ci.org/chrisdinn/vast/settings Under Environment Variables insert NAME: CC_TEST_REPORTER_ID VALUE: <TEST REPORTER ID> BRANCH: All branches Display value in build logs should be off Click Add

Optional: From https://codeclimate.com/github/chrisdinn/vast Repo Settings -> Badges Select the Test Coverage Badge RDOC format Copy the text and add it to the end of the first line in README.rdoc file Only you can do this because the URL to the badge has a unique id for the repo that only you as the git repo owner can see in the code climate web console.

careyrp avatar Oct 08 '19 20:10 careyrp