Skip to content

Introduce code linters to the repo #195

@leofang

Description

@leofang

As #153 is being reviewed, I notice we are struggling in sticking to some formatting preferences like

  • the number of empty lines between code blocks
  • the line endings (which shows up in particular at the end of the file diff)
  • the import order

My rule of thumb: Once the team size is >=3 we should add a code linter, ex: Ruff, plus optionally a pre-commit hook, so that files are linted and updated before checked in. We can further add a pre-commit CI to enforce the checks & code cleanness. Both sides of code review participants should focus only on the functionality/correctness, not formatting.

Metadata

Metadata

Labels

CI/CDCI/CD infrastructureP0High priority - Must do!supportAll things related to the project that can't be categorized

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions