README.md in silvercop-1.0.1 vs README.md in silvercop-1.0.2

- old
+ new

@@ -1,29 +1,14 @@ # Overview This gem houses RuboCop configuration files to be included in Silvercar Ruby projects. -# Branching Strategy +## Known Issues +There's a typo in rubocop 0.77 that gives an invalid warning, which can be ignored. -This repository uses [GitHub flow](https://guides.github.com/introduction/flow/). +Warning: Style/TrivialAccessors does not support AllowedMethods parameter. -* Feature branches should be Pull Requests opened against master. -* Feature branches should begin with the JIRA ticket number - -# Pull Requests -All code merged into master must be merged via a pull request. - -Pull requests must: - -* Have one or more reviewers -* Be approved by one or more reviewers - -Pull requests should: - -* Be small, less than 2 days of work -* Be merged by author after review process - ## Usage Add to gemfile: ```gem 'silvercop'``` @@ -51,17 +36,17 @@ ```ruby inherit_gem: silvercop: .rubocop.yml ``` -It is recommended to use this gem as `bundle exec rubocop -RD`, the two options being to run -Rails cops as well as output the cop in question for that line of code. +It is recommended to use this gem as `bundle exec rubocop -D`, which will output the violated +cop for that line of code If many offenses are detected, it is recommended to generate a TODO list that can be handled over time without needing to fix all of the existing offenses. This can be done by generating and including the following config: -`bundle exec rubocop -RD --auto-gen-config` +`bundle exec rubocop -D --auto-gen-config` Then add `inherit_from: .rubocop_todo.yml` to your `.rubocop.yml` file. Adding `--exclude-limit 10000` can help prevent the generated config from disabling cops entirely with `Enabled: false`. Example usage of configuration inside Ruby project: