whitesmith / whitesmith/rubycritic

Define Ruby Compatibility Policy

Open
#482 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
3.5k
Forks
234
PR merge metrics
No merged PRs in 30d

Description

Hi there,

I think it'd be a good idea to define a compatibility/maintenance policy for the Ruby versions of rubycritic and I think that it should follow the Ruby core team's policy.

I don't see why our (considerably smaller) maintenance team should try to support versions that are not supported by the Ruby maintenance team.

Ruby 2.7 has been EOLed for almost one year now:

Screen Shot 2024-03-02 at 5 39 41 PM

Source: https://www.ruby-lang.org/en/downloads/branches/

I think we should only maintain Rubies that are currently supported:

Screen Shot 2024-03-02 at 5 39 29 PM

That would mean that right now we should only support:

  • 3.0
  • 3.1
  • 3.2
  • 3.3

The advantage of something like this is that we could use the latest version of our dependencies (e.g. reek) -- Right now people expect RubyCritic to work with Ruby 2.7 (e.g. https://github.com/whitesmith/rubycritic/issues/477) and I think that's an unrealistic expectation.

I'd like to know your thoughts on this (especially @nunosilva800)

Thanks,
Ernesto

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing Ruby's supported branches page and the RubyCritic compatibility concern in issue #477. Resolve with maintainers which Ruby versions the project will support, then document the agreed policy and verify that the project's dependency expectations are consistent with it.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.