matz/spinel

0

/ 100

Documentation74
Engineering54
Health53
Ruby1,638MIT1d ago
Grade a repo

Strong community interest, but tests, CI, or docs need work.

Documentation

74

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

54

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

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

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.

Tests18pt80

Test files detected (test).

CI/CD14pt85

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

Project health

53

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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.

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

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 1,638
    Watchers

Responsiveness

  • 6h
    Median issue response
  • 4h
    Median PR merge time
  • 7
    Open issues
Repository files17 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • benchmark
  • docs
  • examples
  • experiments
  • legacy
  • lib
  • src
  • test
    Good: Test files detected (test).
  • tools
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • AUTHORS
  • common.mk
  • LICENSE
    Good: Licensed under MIT.
  • Makefile
  • 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.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.