theopendictionary/odict

0

/ 100

Documentation41
Engineering81
Health100
Rust158GPL-3.01d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

A blazingly-fast, offline-first format and toolchain for lexical data 📖

Documentation

41

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

Contributing guide5pt0

No CONTRIBUTING.md found (−47 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.

README12pt60

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

81

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.

Reproducibility6pt80

Lockfile present (Cargo.lock). Installs are reproducible.

CI/CD14pt85

CI is configured (.github/workflows/build-docs.yml).

Tests18pt100

Test files detected (crates/odict/tests).

Linting and formatting5pt100

Rust linting configured (node/.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (Cargo.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 13
    Forks
  • 152
    Releaseslatest 5y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 158
    Watchers

Responsiveness

  • 3d 24h
    Median issue response
  • 15h
    Median PR merge time
  • 15
    Open issues
Repository files31 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/build-docs.yml).
  • .yarn
  • cli
  • crates
    Good: Test files detected (crates/odict/tests).
  • docs
  • examples
  • node
    Good: Rust linting configured (node/.editorconfig).
  • python
  • scripts
  • .dockerignore
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .oxfmtrc.json
  • .release-please-manifest.json
  • .rumdl.toml
  • .taplo.toml
  • AGENTS.md
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CLAUDE.md
  • dist-workspace.toml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • hk.pkl
  • LICENSE
    Good: Licensed under GPL-3.0.
  • logo.jpg
  • mise.toml
  • odict.tex
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown 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.
    Good: README includes status badges.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • release-please-config.json
  • terminal.png