Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce References #696

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Enforce References #696

wants to merge 6 commits into from

Conversation

sambostock
Copy link
Contributor

@sambostock sambostock commented Feb 21, 2025

We want to document:

  • Why we've enabled every cop we've enabled.
  • Why we've disabled cops the community would enable.
  • Why we've changed default configuration.

We'll do this by appending Reference entries for the relevant cops.

This sets up machinery for enforcing we've done that. As we re-triage cops, we'll update the test so it enforces References across each department.

It also adds References for the cops we've already configured in #687 & #693.

TODO

Now that we require Ruby >= 3.1, we consistently have this method (as
3.1 includes Psych 4, and the method was introduced in 3.2.2).
We want to document:

- Why we've enabled every cop we've enabled.
- Why we've disabled cops the community would enable.
- Why we've changed default configuration.

We'll do this by appending `Reference` entries for the relevant cops.
This sets up machinery for enforcing we've done that. As we re-triage
cops, we'll update the test so it enforces `Reference`s across each
department.
This adds references for configuration decided in "The Great Reset".
This adds a `Reference` for configuration decided in #693.
@sambostock sambostock requested a review from a team as a code owner February 21, 2025 04:26
@github-actions github-actions bot added the config change Changes the Rubocop config by enabling, disabling, or reconfiguring one or many cops label Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
config change Changes the Rubocop config by enabling, disabling, or reconfiguring one or many cops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants