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

Enable additional rules in ruff #3438

Open
11 of 21 tasks
timothy-nunn opened this issue Jan 8, 2025 · 0 comments
Open
11 of 21 tasks

Enable additional rules in ruff #3438

timothy-nunn opened this issue Jan 8, 2025 · 0 comments
Assignees
Labels
Epic Epic issue

Comments

@timothy-nunn
Copy link
Contributor

timothy-nunn commented Jan 8, 2025

This epic will track all of the issues to enable additional rules in ruff that cannot be easily enabled upon its introduction in #3424

The process for enabling a new rule is as follows:

  1. Create and checkout a new branch
  2. Read about the rule you are enforcing at https://docs.astral.sh/ruff/rules
  3. Add the rule to the end of the extend-select list in ruff.toml
  4. Run the linter on the entire codebase by running ruff check --fix in the root of the repository
  5. Fix any of the errors raised until the command in 3 returns "All checks passed!"
  6. Add and commit your changes to ruff.toml and any of the Python files
  7. Create a PR and request my review!

An acceptable resolution to the any of the errors raised by the linter might be to:

  1. Ignore a specific rule for a line of code https://docs.astral.sh/ruff/linter/#error-suppression
  2. Ignore a specific rule for a file https://docs.astral.sh/ruff/settings/#lint_per-file-ignores
  3. Ignore a specific rule for all files https://docs.astral.sh/ruff/linter/#rule-selection
    feel free to discuss this with me!

The following rules should be easily enabled with a few minutes of work

The following fixes will be more involved (multiple papercuts?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic Epic issue
Projects
None yet
Development

No branches or pull requests

1 participant