Establish a coding standards baseline on our Ruby code base
Originally created by @intrigeri on #17646 (Redmine)
Our Ruby code base is far from respecting best practices documented in
the Ruby style guide: at the time I’m creating this issue, rubocop
reports thousands of offenses.
This is not going to change overnight, let’s take it one step at a time
and cut ourselves some slack.
For this first iteration, my main goal is to establish a Ruby coding standards baseline (not necessarily perfect), that would be encoded in such a way that:
- Developers can enable their IDE’s Rubocop integration to avoid introducing regressions wrt. said baseline.
- We can later add CI checks to ensure we don’t regress wrt. said baseline.
- It’s clear whether we diverge on purpose from the Ruby community’s established best practices, or not.
- We can propose & discuss changes to our coding standards. For example, we could decide to either respect rule X of the Ruby style guide, or to consciously diverge from it.
Feature Branch: feature/17646-ruby-coding-standards-baseline+force-all-tests
Related issues
- Related to #17675 (closed)
- Related to #13459 (closed)
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information