tobymao/18xx
Grade a repo

0

/ 100

GradeB

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

A platform for playing 18xx games online!

Documentation52
Engineering90
Health100
Ruby361Othertoday

Documentation

52

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.

README12pt45

README is present.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

License6pt100

Licensed under Other.

Engineering

90

Tests18pt80

Test files detected (spec).

Reproducibility6pt80

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

CI/CD14pt100

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

Linting and formatting5pt100

Ruby linting configured (.editorconfig).

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

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 361
    Watchers

Responsiveness

  • 8h
    Median issue response
  • 1h
    Median PR merge time
  • 325
    Open issues
Repository files41 root entries
  • .bundle
  • .github
    Good: CI is configured (.github/workflows/ruby.yml).
    Good: Issue or PR templates present.
  • assets
  • config
  • db
  • lib
  • migrate
  • models
  • nginx
  • public
  • redis
  • routes
  • scripts
  • spec
    Good: Test files detected (spec).
  • .dockerignore
  • .editorconfig
    Good: Ruby linting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .ignore
  • .rerun.amd64
  • .rspec
  • .rspec_parallel
  • .rubocop.yml
  • api.rb
  • config.ru
  • db.rb
  • DEVELOPMENT.md
  • docker-compose.dev.yml
  • docker-compose.prod.yml
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile.amd64
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • LICENSE
    Good: Licensed under Other.
  • Makefile
  • models.rb
  • queue.rb
  • Rakefile
  • 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.
    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.
    Good: README documents how to run the project.
  • TILES.md