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

Make a policy for ruff rule inclusion #123

Open
nathanjmcdougall opened this issue Nov 16, 2024 · 0 comments
Open

Make a policy for ruff rule inclusion #123

nathanjmcdougall opened this issue Nov 16, 2024 · 0 comments
Assignees
Labels
philosophy Determining the best design approach

Comments

@nathanjmcdougall
Copy link
Owner

Motivation
Some ruff rules are more controversial than others. With opinionated defaults, users might stumble across rules which don't match their usual workflow. There might be a few responses:

  • Objection/Paternalism - not change the default usethis config and ask the user to change their way of working. This is sometimes justified, one of the objectives with usethis is to make it difficult to avoid best practice.
  • Agreement - i.e. we'll disable the rule: it's either a questionable or at least controversial rule - erring on the side of caution seems wise.
  • Defer - wait for more feedback to accumulate; is this just a one-person issue or is the problematic rule commonly an issue?
  • Multiple behaviours - somehow codify the different workflows with their own usethis interface. This is more work but presumably gives the best UX. There's still a default behaviour though, so controversy isn't necessarily avoided.

But how do we assess a rule to decide on its inclusion? How is this decision actually made? Yes, it will always be opinionated to some degree, but some thought needs to go into the actual policy so it can be documented.

Summary of desired enhancement
Consider a policy for when a rule rule should be included or not.

@nathanjmcdougall nathanjmcdougall added the philosophy Determining the best design approach label Nov 16, 2024
@nathanjmcdougall nathanjmcdougall self-assigned this Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
philosophy Determining the best design approach
Projects
None yet
Development

No branches or pull requests

1 participant