BurntSushi/xsvNew scan
78/ 100 · C

Popular and well-maintained. A little polish away from elite status.

A fast CSV command line toolkit written in Rust.

Rust10,750 starsUnlicenseupdated 1y ago
DocumentationREADME, setup, examples, license
82
EngineeringTests, CI, linting, lockfiles
74
Project healthDescription, activity, stars, deps
79

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Install and run instructions
    DocumentationInfo

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

  2. 2
    Reproducibility
    EngineeringInfo

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

  3. 3
    Reproducibility
    EngineeringInfo

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

Detailed breakdown

Documentation

82
  • 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 Unlicense.
  • Contributing guide0
    • No CONTRIBUTING.md found (−45 pts base + up to −53 pts more for content).Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
    • 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

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

    Not applicable?

    • CI is configured (.travis.yml).
  • Linting and formatting40
    • Rust projects have clippy available. Run `cargo clippy` for linting.
    • CI does not appear to run `cargo clippy` (−40 pts vs enforcing it in CI).Add `cargo clippy -- -D warnings` and `cargo fmt --check` as CI steps.
    • No rustfmt.toml found.Add a rustfmt.toml to enforce a consistent code style across contributors.
  • Reproducibility70
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • 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.
    • Cargo.toml does not specify edition 2021.Add `edition = "2021"` to [package] in Cargo.toml for the latest Rust language features.
  • Issue and PR templates0
    • No issue or PR templates found (−90 pts).Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

79
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml includes a description for crates.io.
    • Cargo.toml declares a license.
    • Cargo.toml links to the source repository.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Rust.
    • Cargo.toml [package] metadata is complete (description, authors, repository).
  • Activity20
    • No pushes in over a year.A recent commit signals the project is alive and worth contributing to.
    • 10,750 stars.
  • Housekeeping100
    • .gitignore present.
Repository files16 root entries
  • ci
  • scripts
  • src
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • .travis.yml
    Good: CI is configured (.travis.yml).
  • appveyor.yml
  • BENCHMARKS.md
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • COPYING
  • LICENSE-MIT
  • Makefile
  • 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.
  • session.vim
  • UNLICENSE