Gitlab::Styles centralizes some shared GitLab's styles config (only RuboCop
for now), as well as custom RuboCop cops.
Add this line to your application's Gemfile:
gem 'gitlab-styles', require: false
And then execute:
Or install it yourself as:
$ gem install gitlab-styles
Inherit all rules
Include the following in your
.rubocop.yml and remove all the rules that are
inherit_gem: gitlab-styles: - rubocop-default.yml
Inherit only some kind of rules
The rules are grouped by type so you can choose to inherit only some kind of rules:
inherit_gem: gitlab-styles: - rubocop-gemspec.yml - rubocop-naming.yml
After checking out the repo, run
bin/setup to install dependencies.
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.
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 code of conduct.
Please refer to the Release Process.
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the
Gitlab::Styles project’s codebases, issue trackers,
chat rooms and mailing lists is expected to follow the
code of conduct.