Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add codeclimate cli instructions. #1043

Merged
merged 6 commits into from
Sep 3, 2016
Merged

Add codeclimate cli instructions. #1043

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ee5af3d
Add codeclimate cli instructions.
bkyryliuk Aug 30, 2016
763d2dd
Merge branch 'master' into bkyryliuk-codeclimate-cli
bkyryliuk Aug 31, 2016
16bae6a
Merge branch 'master' into bkyryliuk-codeclimate-cli
bkyryliuk Aug 31, 2016
e3717ff
Update CONTRIBUTING.md
bkyryliuk Sep 3, 2016
f31720d
Update CONTRIBUTING.md
bkyryliuk Sep 3, 2016
38bc1a2
Merge branch 'master' into bkyryliuk-codeclimate-cli
bkyryliuk Sep 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd had a note:

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks

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