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

[FEATURE] Move pre-commit hooks to ruff #1002

Open
6 tasks
callumtilbury opened this issue Feb 5, 2024 · 0 comments
Open
6 tasks

[FEATURE] Move pre-commit hooks to ruff #1002

callumtilbury opened this issue Feb 5, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@callumtilbury
Copy link
Contributor

callumtilbury commented Feb 5, 2024

Feature

There have been many discussions to move our python tooling to ruff, as seen in many popular libraries in the community. This will be a big once-off effort, but will make our pre-commit hooks much faster.

Proposal

Once-off big push to use ruff's tooling. Will need to match current settings to those in ruff in the best way possible.

Testing

Tested by inspection, to see if we're happy with the formatting styles from ruff.

Benchmarking (Optional)

n/a

Definition of done

When ruff is used for our pre-commit hooks in Mava.

Mandatory checklist before making a PR

  • The success criteria laid down in “Definition of done” are met.
  • Code is documented - docstrings for methods and classes, static types for arguments.
  • Code is tested - unit, integration and/or functional tests are added.
  • Documentation is updated - README, CONTRIBUTING, or other documentation.
  • All functional tests are green.
  • Link experiment/benchmarking after implementation (optional).

Links / references / screenshots

https://github.com/astral-sh/ruff

@callumtilbury callumtilbury added the enhancement New feature or request label Feb 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant