Skip to content

Clarify Ruff installation requirement before running lint commands #738

@Tithi234

Description

@Tithi234

Hi 👋,

In the "Running Code Style Checks" section of the README, contributors are instructed to run:

However, it may not be immediately clear to new contributors that Ruff needs to be installed first.

Would it be helpful to briefly mention how to install Ruff (for example via pip or from requirements.txt) before running these commands?

Happy to open a PR with a suggested clarification if this sounds reasonable.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions