helix-editor/helixNew scan
90/ 100 · A

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

A post-modern modal text editor.

Rust44,878 starsMPL-2.0updated 3d ago
DocumentationREADME, setup, examples, license
87
EngineeringTests, CI, linting, lockfiles
91
Project healthDescription, activity, stars, deps
92

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
    README
    DocumentationInfo

    Show a quick-start snippet so contributors can see what using your project looks like.

  3. 3
    Install and run instructions
    DocumentationInfo

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

Detailed breakdown

Documentation

87
  • README85
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • 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 MPL-2.0.
  • Contributing guide70
    • Contributing guide is detailed and thorough.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide explains how to run tests.
    • Contributing guide lacks a PR workflow section (−8 pts).Explain how to fork, branch, and open a pull request so contributors know what to expect.
    • 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

91
  • Tests90
    • Test files detected (helix-core/tests).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/build.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 tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting60
    • Linter or formatter configured (rustfmt.toml).
  • Reproducibility100
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via runtime/queries/dockerfile.
    • Dependabot covers 2 ecosystems (cargo, github-actions). Dependencies stay current.
  • 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

92
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml is a workspace manifest for a multi-crate Rust project.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 44,878 stars.
  • Housekeeping100
    • .gitignore present.
Repository files43 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot covers 2 ecosystems (cargo, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • book
  • contrib
  • docs
  • helix-core
    Good: Test files detected (helix-core/tests).
  • helix-dap
  • helix-dap-types
  • helix-event
  • helix-loader
  • helix-lsp
  • helix-lsp-types
  • helix-parsec
  • helix-stdx
  • helix-term
  • helix-tui
  • helix-vcs
  • helix-view
  • runtime
    Good: Environment pinned via runtime/queries/dockerfile.
  • tests
  • xtask
  • .envrc
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • base16_theme.toml
  • 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.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Info: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Good: Contributing guide explains how to run tests.
    Info: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • default.nix
  • flake.lock
  • flake.nix
  • grammars.nix
  • languages.toml
  • LICENSE
    Good: Licensed under MPL-2.0.
  • logo_dark.svg
  • logo_light.svg
  • logo.svg
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Info: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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.
  • rust-toolchain.toml
  • rustfmt.toml
    Good: Linter or formatter configured (rustfmt.toml).
  • screenshot.png
  • shell.nix
  • theme.toml