https://github.com/rubyeffect/rails_review

Ruby Gem to check the code for standards compiled in the Rails Style Guide repository. By http://www.rubyeffect.com
https://github.com/rubyeffect/rails_review

code-review rails rails-review rails-style-guide ruby-gem

Last synced: 9 days ago
JSON representation

Ruby Gem to check the code for standards compiled in the Rails Style Guide repository. By http://www.rubyeffect.com

• Host: GitHub
• URL: https://github.com/rubyeffect/rails_review
• Owner: rubyeffect
• License: mit
• Created: 2016-07-27T13:55:47.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-02-08T11:07:29.000Z (almost 8 years ago)
• Last Synced: 2024-11-21T10:13:05.219Z (2 months ago)
• Topics: code-review, rails, rails-review, rails-style-guide, ruby-gem
• Language: Ruby
• Homepage:
• Size: 6.84 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Rails Review

Rails Review gem checks your rails applications against style guides present at [Rails Style Guide Repository](https://github.com/bbatsov/rails-style-guide) and reports the code snippets where the style guide is not met.

## Installation

Add this line to your application's Gemfile in the development group:

```ruby

gem 'rails_review'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install rails_review

## Usage

Run the following rake task to start the rails style guide checks on your application.

    $ rake rails_review:start

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`.

## Contributing

1. Fork it ( https://github.com/rubyeffect/rails_review/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## Note

In the current version, 17 [Rails Style Guide](https://github.com/bbatsov/rails-style-guide) points are being checked. Further checks would be added in future commits.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

## Authored by

Sanjay Vedula([email protected])

## About RubyEffect



  



RubyEffect builds intuitive, live and elegant software that solves real world problems. We love open source and it's community.

Liked this gem? You may also like the articles we post on our [blog](http://blog.rubyeffect.com). Please do check

We would love to work on your ideas and see them grow. Say hello @ http://rubyeffect.com/contact