usetrmnl/terminus

0

/ 100

Documentation62
Engineering63
Health100
Ruby600MIT1d ago
Grade a repo

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

The flagship TRMNL BYOS application.

Documentation

62

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.

README12pt48

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

63

Linting and formatting5pt0

No RuboCop config found.

→ Add a .rubocop.yml and run `rubocop` in CI to enforce consistent Ruby style.

CI/CD14pt40

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

Tests18pt80

Test files detected (spec).

Reproducibility6pt80

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (Gemfile).

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

Community

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

Responsiveness

  • 5h
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files30 root entries
  • .circleci
  • .config
  • .github
    Good: CI is configured (.github/workflows/docker.yml).
    Good: Issue or PR templates present.
  • app
  • bin
  • config
  • doc
  • lib
  • public
  • scripts
  • slices
  • spec
    Good: Test files detected (spec).
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .hadolint.yml
  • .node-version
  • .reek.yml
  • .ruby-version
  • compose.yml
  • config.ru
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • LICENSE.adoc
    Good: Licensed under MIT.
  • package-lock.json
  • package.json
  • Procfile
  • Rakefile
  • README.adoc
    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.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • render.yaml