Open
Description
Description
Create a linter command that lints my current clone of torchx.
Motivation/Background
Currently our scripts/lint.sh is designed to run as a github action. Hence it will:
- clone torchx github repo
- run the linters: usort, black, flake8, copyright, pyre
This isn't too useful if you are a developer with torchx already checked out and you'd like to lint your code to fix lint errors locally before submitting a PR.
Detailed Proposal
Either:
- Make the existing
scripts/lint.sh
take an argument (e.g.--dir ~/workspace/torchx
) to lint all the files in my current torchx workspace - -- or -- create a new lint script aimed at developers who want to lint their code before submitting a PR.
Alternatives
Do nothing and hurt developer experience since the dev has to submit the PR -> wait for the actions to run -> if there is a lint error fix it -> rinse and repeat.
Additional context/links
N/A