zellij-org/zellijNew scan
90/ 100 · A

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

A terminal workspace with batteries included

Rust33,596 starsMITupdated 6d ago
DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
87
Project healthDescription, activity, stars, deps
87

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  2. 2
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    CI/CD
    EngineeringInfo

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

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 guide100
    • 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.
    • Code of conduct present.

Engineering

87
  • Tests90
    • Test files detected (src/tests).
    • Cargo.toml has dev-dependencies and test files are present.
  • CI/CD85

    Not applicable?

    • CI is configured (.github/workflows/e2e.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI tests across multiple environments or versions.
  • Linting and formatting60
    • Linter or formatter configured (.editorconfig).
  • Reproducibility100
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via docker-compose.yml.
    • Dependabot covers 3 ecosystems (github-actions, cargo, cargo). Dependencies stay current.
    • Cargo.toml does not specify edition 2021.Add `edition = "2021"` to [package] in Cargo.toml for the latest Rust language features.
  • 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

87
  • Dependency manifest70
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml includes a description for crates.io.
    • Cargo.toml is missing a license field (−10 pts).Add `license = "MIT"` (or your preferred SPDX identifier) to [package].
    • Cargo.toml is missing a repository field (−10 pts).Add `repository = "https://github.com/owner/repo"` to [package].
  • Repository metadata85
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 33,596 stars.
  • Housekeeping100
    • .gitignore present.
Repository files28 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/e2e.yml).
    Good: Dependabot covers 3 ecosystems (github-actions, cargo, cargo). Dependencies stay current.
    Good: Issue or PR templates present.
  • assets
  • default-plugins
  • docs
  • example
  • src
    Good: Test files detected (src/tests).
  • wix
  • xtask
  • zellij-client
  • zellij-server
  • zellij-tile
  • zellij-tile-utils
  • zellij-utils
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .rustfmt.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.
    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.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
  • docker-compose.yml
    Good: Environment pinned via docker-compose.yml.
  • funding.json
  • GOVERNANCE.md
  • LICENSE.md
    Good: Licensed under MIT.
  • 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.
  • rust-toolchain.toml