Skip to content

Commit

Permalink
Add appraisals documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
franciscoj committed Oct 10, 2016
1 parent 7ab463a commit 5acd998
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ inspired by [`rubocop-rspec`](https://github.com/nevir/rubocop-rspec).

Just install the `rubocop-migrations` gem

```bash
```shell
gem install rubocop-migrations
```

Expand Down Expand Up @@ -38,7 +38,7 @@ cops together with the standard cops.

### Command line

```bash
```shell
rubocop --require rubocop/migrations
```

Expand All @@ -64,6 +64,24 @@ Migrations/RemoveIndex:
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

### Running the tests

We use Appraisals in order to run the tests with different rubocop versions to
ensure compatibility.

To run the specs with all supported rubocop versions first install the required
dependencies with:

```shell
bundle exec appraisals install
```

Then run the specs by just running `rake` it will run specs with all the
versions.

For more info just check the appraisals documentation
https://github.com/thoughtbot/appraisal

## License

`rubocop-migrations` is MIT
Expand Down

0 comments on commit 5acd998

Please sign in to comment.