https://github.com/autolist/autocop

Autolist ruby style guide gem
https://github.com/autolist/autocop

Last synced: 8 days ago
JSON representation

Autolist ruby style guide gem

• Host: GitHub
• URL: https://github.com/autolist/autocop
• Owner: autolist
• License: mit
• Created: 2018-02-22T01:49:17.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-11-01T18:10:45.000Z (13 days ago)
• Last Synced: 2024-11-01T19:18:58.203Z (13 days ago)
• Language: Ruby
• Size: 161 KB
• Stars: 0
• Watchers: 11
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Autocop

[![Gem Version](https://badge.fury.io/rb/autocop.svg)](https://badge.fury.io/rb/autocop)

[![Build Status](https://travis-ci.org/autolist/autocop.svg?branch=master)](https://travis-ci.org/autolist/autocop)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=autolist/autocop)](https://dependabot.com)

Autolist approved ruby style rules to write code without worrying about upsetting

your fellow developer.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'autocop'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install autocop

## Usage

After installing the gem in your code you can add the following to your

`.rubocop.yml` file to tell it to enforce the styles from the `autocop` gem

```yaml

inherit_gem:

  autocop: .autocop-rubocop.yml

```

## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/autolist/autocop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

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

## Code of Conduct

Everyone interacting in the Autocop project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/autolist/autocop/blob/master/CODE_OF_CONDUCT.md).