facebook/rocksdb

0

/ 100

Documentation66
Engineering47
Health100
C++31,783GPL-2.05d ago
Grade a repo

Strong community interest, but docs and engineering haven't caught up to the hype.

A library that provides an embeddable, persistent key-value store for fast storage.

Documentation

66

Install and run instructions9pt45

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt60

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt68

README is present.

License6pt100

Licensed under GPL-2.0.

Engineering

47

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

CI/CD14pt57

CI is configured (.github/workflows/ai-review-analysis.yml).

Tests18pt80

Test files detected (.github/scripts/post-pr-comment.test.js).

Project health

100

Dependency manifest6pt100

Dependency manifest found (docs/Gemfile).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files69 root entries
  • .github
    Good: Test files detected (.github/scripts/post-pr-comment.test.js).
    Good: CI is configured (.github/workflows/ai-review-analysis.yml).
  • buckifier
  • build_tools
    Good: Environment pinned via build_tools/ubuntu20_image/Dockerfile.
  • cache
  • claude_md
  • cmake
  • coverage
  • db
  • db_stress_tool
  • docs
    Good: Dependency manifest found (docs/Gemfile).
  • env
  • examples
  • file
  • fuzz
  • githooks
  • include
  • java
  • logging
  • memory
  • memtable
  • microbench
  • monitoring
  • options
  • plugin
  • port
  • table
  • test_util
  • third-party
  • tools
  • trace_replay
  • unreleased_history
  • util
  • utilities
  • wiki
  • .clang-format
  • .clang-tidy
  • .gitignore
    Good: .gitignore present.
  • .lgtm.yml
  • .watchmanconfig
  • AGENTS.md
  • AUTHORS
  • BUCK
  • ccache_msvc_compiler.bat
  • CLAUDE.md
  • CMakeLists.txt
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • common.mk
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • COPYING
  • crash_test.mk
  • DEFAULT_OPTIONS_HISTORY.md
  • Directory.Build.props
  • DUMP_FORMAT.md
  • folly.mk
  • HISTORY.md
  • INSTALL.md
  • issue_template.md
  • LANGUAGE-BINDINGS.md
  • LICENSE.Apache
    Good: Licensed under GPL-2.0.
  • LICENSE.leveldb
  • Makefile
  • PLUGINS.md
  • README.md
    Good: README is present.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: 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.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • rocksdb.pc.in
  • src.mk
  • thirdparty.inc
  • USERS.md
  • Vagrantfile
  • WINDOWS_PORT.md