[RFC][Votable] Code Quality Tools Integration (Linter & Formatter & Import Organizer)

[tongyx361]

Motivation

The current imports in the verl repository is messy. We might need some tool to streamline and standardize import management.

Draft Proposal

Given our current development pipeline that utilizes yapf for formatting and pylint for linting, we present two primary options:

1. 😄 Integrate isort into the existing pipeline for import organization.
2. 🚀 Migrate to ruff, a comprehensive tool that can handle formatting, linting, and import organization simultaneously.

Question(s) to Discuss

Which option would be more suitable for our needs? You could make a vote under this issue using 😄 for isort or 🚀 for ruff.

Additional Notes

This RFC issue is adapted from vLLM's awesome RFC issue template. If such a template seems useful to you, we may consider adding similar templates to the verl repository.

CC

@vermouth1992 @eric-haibin-lin @PeterSH6 @hiyouga @ETOgaosion @BearBiscuit05

Before Submitting

• Have already searched for relevant issues

[eric-haibin-lin]

Does ruff support auto-formatting if the format does not meet the rule?

[hongpeng-guo]

Does ruff support auto-formatting if the format does not meet the rule?

we can enable auto-formating with pre-commit, adding ruff as a hook of the pre-commit will apply the ruff rules.

[tongyx361]

Does ruff support auto-formatting if the format does not meet the rule?

we can enable auto-formating with pre-commit, adding ruff as a hook of the pre-commit will apply the ruff rules.

Indeed, I configured this before and I can help if we decide to migrate to ruff.

[vermouth1992]

Will there be a check if pre-commit is skipped by the user?