iadnanmukhtar/hadithdb

0

/ 100

Documentation21
Engineering67
Health81
HTML51d ago
Grade a repo

Early stage. Tests, CI, and a strong README would raise this score quickly.

Documentation

21

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

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.

README12pt55

README is present.

Engineering

67

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.

CI/CD14pt40

CI is configured (.github/workflows/main.yml).

Reproducibility6pt70

Lockfile present (package-lock.json). Installs are reproducible.

Tests18pt100

Test script and framework are configured in package.json.

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.json).

Project health

81

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt90

Dependency manifest found (package.json).

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)
  • 0
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 6h
    Median issue response
  • <1h
    Median PR merge time
  • 2
    Open issues
Repository files17 root entries
  • .github
    Good: CI is configured (.github/workflows/main.yml).
  • .vscode
  • bin
  • data
  • hadithdb-schema
  • lib
  • public
  • routes
  • views
  • .eslintrc.json
    Good: Linter or formatter configured (.eslintrc.json).
  • .gitignore
    Good: .gitignore present.
  • app.js
  • jsconfig.json
  • newrelic.js
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.