From 4bf2734047500be1cf79cfe0630ac91e4ca3ff05 Mon Sep 17 00:00:00 2001 From: Tim Meusel Date: Fri, 28 Jun 2024 12:27:42 +0200 Subject: [PATCH] Document major-releases policy --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index e19ccce..2f06118 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,9 @@ [![RubyGem Version](https://img.shields.io/gem/v/voxpupuli-rubocop.svg)](https://rubygems.org/gems/voxpupuli-rubocop) [![RubyGem Downloads](https://img.shields.io/gem/dt/voxpupuli-rubocop.svg)](https://rubygems.org/gems/voxpupuli-rubocop) +* [Usage](#usage) +* [New major releases](#new-major-releases) + This is one of the Vox Pupuli meta gems. It provides a convenient way to configure [RuboCop](https://rubocop.org/). RuboCop is the de facto standard Ruby Linter and Formatter. `voxpupuli-rubocop` depends on the correct RuboCop version @@ -64,3 +67,22 @@ violations: ``` bundle exec rubocop --regenerate-todo ``` + +## New major releases + +As described above, we will do new minor releases of voxpupuli-rubocop with +newer RuboCop dependencies. We also ship a rubocop.yml that people can use. This +file currently configures Ruby 2.7 as a target version. This will be adjusted in +major releases. + +User of voxpupuli-rubocop don't have to use our rubocop.yml, they can just rely +on our curated list of rubocop dependencies. Or overwrite the target version in +their own rubocop.yaml: + +``` +inherit_gem: + voxpupuli-rubocop: rubocop.yml + +AllCops: + TargetRubyVersion: '3.3' +```