tantivy-search/tantivyNew scan
87/ 100 · B

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

Tantivy is a full-text search engine library inspired by Apache Lucene and written in Rust

Rust15,389 starsMITupdated 4d ago
DocumentationREADME, setup, examples, license
93
EngineeringTests, CI, linting, lockfiles
78
Project healthDescription, activity, stars, deps
100

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
    Install and run instructions
    DocumentationInfo

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

Detailed breakdown

Documentation

93
  • 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 guide70
    • CONTRIBUTING guide or docs directory present.
    • 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

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

    Not applicable?

    • CI is configured (.github/workflows/test.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.
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting60
    • Linter or formatter configured (rustfmt.toml).
  • Reproducibility25
    • No Cargo.lock found (−70 pts). Rust binary/application crates should commit Cargo.lock.Run `cargo build` and commit the resulting Cargo.lock file.
    • 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.
    • Dependabot covers 2 ecosystems (cargo, github-actions). Dependencies stay current.
    • Cargo.toml uses Rust edition 2021 (current best practice).
  • 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

100
  • 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).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 15,389 stars.
  • Housekeeping100
    • .gitignore present.
Repository files28 root entries
  • .claude
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Dependabot covers 2 ecosystems (cargo, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • benches
  • bitpacker
  • columnar
  • common
  • doc
  • examples
  • ownedbytes
  • query-grammar
  • src
  • sstable
    Good: Test files detected (sstable/tests).
  • stacker
  • tests
  • tokenizer-api
  • .gitignore
    Good: .gitignore present.
  • ARCHITECTURE.md
  • AUTHORS
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
    Good: CONTRIBUTING guide or docs directory present.
  • CITATION.cff
  • cliff.toml
  • LICENSE
    Good: Licensed under 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.
  • RELEASE.md
  • rustfmt.toml
    Good: Linter or formatter configured (rustfmt.toml).
  • TODO.txt