README.md in rubocop-govuk-4.1.0 vs README.md in rubocop-govuk-4.2.0
- old
+ new
@@ -1,9 +1,11 @@
# RuboCop GOV.UK
-This repository provides common RuboCop rules for use with GOV.UK Ruby projects to comply with our [style guides][guides].
+Defines the linting rules for GDS Ruby applications, primarily those associated with GOV.UK.
+GOV.UK has used a styleguide for many years, starting with rules in written form, which we then [automated with RuboCop](https://github.com/alphagov/styleguides/commit/cb589cdc4ba17f9c341f4db75900e554dd042672#diff-99f257b41e6471357be7e37c3a41d79045d11f7f0ae1000d6f7fc63b502273e7) and later [moved into this repo](https://github.com/alphagov/govuk-rfcs/blob/main/rfc-100-linting.md#proposal). A styleguide is a valuable asset: it keeps our code consistent and prevents stylistic squabbles. Everyone on GOV.UK is encouraged to use it in their Ruby projects and [contribute](CONTRIBUTING.md) to dependency upgrades and new releases, keeping pace with the rest of the Ruby community.
+
## Installation
Add `rubocop-govuk` to your Gemfile and then run `bundle install`:
```ruby
@@ -40,10 +42,8 @@
rubocop-govuk:
...
- config/rspec.yml
```
-## Testing
+## Contributing
-Run `bundle exec rake`.
-
-[guides]: https://github.com/alphagov/styleguides
+Rules in this repo are defined based on their compatibility with GOV.UK apps and their code conventions. Everyone else is welcome to use it and suggest changes - see [CONTRIBUTING.md](CONTRIBUTING.md) for more details.