Skip to content

Commit

Permalink
Add codeclimate cli instructions. (#1043)
Browse files Browse the repository at this point in the history
* Add codeclimate cli instructions.

Add the instructions for the users that want to mess around with the codeclimate cli.
It is useful to test locally the config changes.

Reviewers:
* @mistercrunch 
* @ascott 
* @vera-liu

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md
  • Loading branch information
bkyryliuk authored Sep 3, 2016
1 parent 9914901 commit 544b3f3
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,30 @@ Lint the project with:
# for javascript
npm run lint

## Linting with codeclimate
Codeclimate is a service we use to measure code quality and test coverage. To get codeclimate's report on your branch, ideally before sending your PR, you can setup codeclimate against your Caravel fork. After you push to your fork, you should be able to get the report at http://codeclimate.com . Alternatively, if you prefer to work locally, you can install the codeclimate cli tool.

*Install the codeclimate cli tool*
```
curl -L https://github.com/docker/machine/releases/download/v0.7.0/docker-machine-`uname -s`-`uname -m` > /usr/local/bin/docker-machine && chmod +x /usr/local/bin/docker-machine
brew install docker
docker-machine create --driver virtual box default
docker-machine env default
eval "$(docker-machine env default)"
docker pull codeclimate/codeclimate
brew tap codeclimate/formulae
brew install codeclimate
```

*Run the lint command:*
```
docker-machine start
eval "$(docker-machine env default)”
codeclimate analyze
```
More info can be found here: https://docs.codeclimate.com/docs/open-source-free


## API documentation

Generate the documentation with:
Expand Down

0 comments on commit 544b3f3

Please sign in to comment.