README.md in gitlab-styles-9.0.0 vs README.md in gitlab-styles-9.1.0
- old
+ new
@@ -64,24 +64,44 @@
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).
+To test some rules locally, there is a test application [in the playground folder](./playground/). It is a vanilla Rails 6 application with your local `gitlab-styles` included, and it is used to test RuboCop rules. You can add code in it (preferably RuboCop offenses) and run the following command to test the RuboCop policy we setup:
+```shell
+cd playground
+bundle install
+bundle exec rubocop -c .rubocop.yml
+```
+
+### Activate lefthook locally
+
+```shell
+lefthook install
+```
+
## Contributing
Bug reports and merge requests are welcome on GitLab at
https://gitlab.com/gitlab-org/gitlab-styles. 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.
## Release Process
-Please refer to the [Release Process](docs/release_process.md).
+We release `gitlab-styles` on an ad-hoc basis. There is no regularity to when
+we release, we just release when we make a change - no matter the size of the
+change.
+
+To release a new version:
+
+1. Create a Merge Request.
+1. Use Merge Request template [Release.md](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/blob/master/.gitlab/merge_request_templates/Release.md).
+1. Follow the instructions.
+1. A new gem version is [published automatically](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/gem-release.yml) after the Merge Request has been merged.
+
+See [!123](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/123) as an example.
## License
The gem is available as open source under the terms of the
[MIT License](http://opensource.org/licenses/MIT).