Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/switchdreams/switchcop
Switch Dreams’s Rails/Ruby Style Guide
https://github.com/switchdreams/switchcop
Last synced: about 1 month ago
JSON representation
Switch Dreams’s Rails/Ruby Style Guide
- Host: GitHub
- URL: https://github.com/switchdreams/switchcop
- Owner: SwitchDreams
- License: mit
- Created: 2022-12-12T18:14:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T12:52:41.000Z (4 months ago)
- Last Synced: 2024-11-18T11:27:45.030Z (about 2 months ago)
- Language: Ruby
- Size: 40 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Switchcop
Ruby is the main language used in SwitchDreams, and to help enforce our style guide in our projects we created Switchcop as our main Rubocop configuration gem and to serve as the Style Guide itself. We intend to update this gem as our style guide gets better over time.
## Installation
Add this line to your application's Gemfile:
```ruby
gem "switchcop", require: false
```
## Usage
Add switchcop's Rubocop configuration file to your .rubocop.yml:
```yml
inherit_gem:
switchcop: rubocop.yml
```
For more information about inheriting configuration from a gem please check RuboCop's documentation.
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/[USERNAME]/switchcop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/switchcop/blob/master/CODE_OF_CONDUCT.md).
## 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 Switchcop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/switchcop/blob/master/CODE_OF_CONDUCT.md).