Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/theodorton/hound-rubocop

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/theodorton/hound-rubocop
Owner: theodorton
License: mit
Created: 2014-11-14T20:46:13.000Z (about 10 years ago)
Default Branch: master
Last Pushed: 2014-11-15T00:24:20.000Z (about 10 years ago)
Last Synced: 2023-04-10T00:17:32.746Z (over 1 year ago)
Language: Ruby
Size: 148 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

# Hound Rubocop

## Installation

Add `hound-rubocop` to your `Gemfile`.

```ruby
# Gemfile
gem "hound-rubocop"
```

## Usage

Generate the Rubocop and Hound configuration.

```shell
$ rails g hound:config
```

That's it! No more configuration needed.

Rubocop will use the generated `.rubocop.yml` by default and report the same offenses as Hound will.

```shell
$ bundle exec rubocop
```

## Using with `guard-rubocop`

No configuration needed.

## Contributing to hound-rubocop

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
* Start a feature/bugfix branch.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.