Skip to content

[torchx/devX] Create a linter command for non-fb developers #321

Open
@kiukchung

Description

@kiukchung

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:

  1. clone torchx github repo
  2. 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:

  1. Make the existing scripts/lint.sh take an argument (e.g. --dir ~/workspace/torchx) to lint all the files in my current torchx workspace
  2. -- 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

Metadata

Metadata

Assignees

Labels

cliRelated to the CLIenhancementNew feature or request

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions