astral-sh/ruffNew scan
89/ 100 · B

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

An extremely fast Python linter and code formatter, written in Rust.

Rust47,975 starsMITupdated 2d ago
DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
82
Project healthDescription, activity, stars, deps
94

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  2. 2
    Install and run instructions
    DocumentationInfo

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility
    EngineeringInfo

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

Detailed breakdown

Documentation

97
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under MIT.
  • Contributing guide98
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

82
  • Tests60
    • Test files detected (crates/ruff/resources/test).
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/build-binaries.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting100
    • Linter or formatter configured (.editorconfig).
    • pyproject.toml configures a Python formatter or linter (ruff/black).
    • No [tool.mypy] in pyproject.toml (−20 pts vs having both ruff and mypy).Install mypy and add a [tool.mypy] section to pyproject.toml for type checking.
  • Reproducibility80
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via Dockerfile.
    • Dockerfile uses multi-stage builds (smaller, more secure images).
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

94
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • pyproject.toml has a [project] table with package metadata.
    • pyproject.toml includes a description.
    • pyproject.toml specifies requires-python, preventing installs on incompatible versions.
    • pyproject.toml has a [build-system] table. The package can be built and published.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Rust.
    • pyproject.toml [project] metadata is complete (description, authors, urls).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 47,975 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (crates/ty_vendored/vendor/typeshed/stdlib/venv/__init__.pyi) (−40 pts).Remove them and add to .gitignore.
Repository files43 root entries
  • .agents
  • .cargo
  • .claude
  • .config
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/build-binaries.yml).
    Good: Issue or PR templates present.
  • .vscode
  • assets
  • changelogs
  • crates
    Good: Test files detected (crates/ruff/resources/test).
    Warning: Build artifacts or local files may be committed (crates/ty_vendored/vendor/typeshed/stdlib/venv/__init__.pyi) (−40 pts).Fix: Remove them and add to .gitignore.
  • docs
  • fuzz
  • playground
  • python
  • scripts
  • _typos.toml
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .ignore
  • .markdownlint.yaml
  • .pre-commit-config.yaml
  • .prettierignore
  • AGENTS.md
  • BREAKING_CHANGES.md
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CLAUDE.md
  • clippy.toml
  • CONTRIBUTING.md
  • dist-workspace.toml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • LICENSE
    Good: Licensed under MIT.
  • mkdocs.template.yml
  • mkdocs.yml
  • pyproject.toml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • ruff.schema.json
  • rust-toolchain.toml
  • rustfmt.toml
  • ty.schema.json