tikv/tikvNew scan
88/ 100 · B

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

Distributed transactional key-value database, originally created to complement TiDB

Rust16,716 starsApache-2.0updated 4d ago
DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
78
Project healthDescription, activity, stars, deps
98

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringWarning

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD
    EngineeringInfo

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

  3. 3
    CI/CD
    EngineeringInfo

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

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 Apache-2.0.
  • 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

78
  • Tests90
    • Test files detected (components/backup-stream/tests).
    • Cargo.toml has dev-dependencies and test files are present.
  • CI/CD57

    Not applicable?

    • CI is configured (.github/workflows/tikv-clippy-darwin.yml).
    • The CI workflow does not appear to run any tests (−28 pts).Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
    • 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 caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
  • Linting and formatting60
    • Linter or formatter configured (components/crossbeam-skiplist/rustfmt.toml).
  • Reproducibility85
    • 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.
    • Cargo.toml uses Rust edition 2021 (current best practice).
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

98
  • Dependency manifest95
    • 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).
    • 16,716 stars.
  • Housekeeping100
    • .gitignore present.
Repository files43 root entries
  • .agents
  • .config
  • .github
    Good: CI is configured (.github/workflows/tikv-clippy-darwin.yml).
    Good: Issue or PR templates present.
  • ci-build
  • cmd
  • components
    Good: Test files detected (components/backup-stream/tests).
    Good: Linter or formatter configured (components/crossbeam-skiplist/rustfmt.toml).
  • doc
  • etc
  • fuzz
  • images
  • metrics
  • patches
  • scripts
  • security
  • src
  • tests
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • AGENTS.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
  • CODE_COMMENT_STYLE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • CONTRIBUTING.md
  • deny.toml
  • docker-compose.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.
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.FIPS
  • Dockerfile.test
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • OWNERS
  • OWNERS_ALIASES
  • PERFORMANCE_CRITICAL_PATH.md
  • README.md
  • rust-toolchain.toml
  • rustfmt.toml
  • SECURITY.md
    Good: Security policy present.