0
/ 100
Good shape overall. A few tweaks would push it into the top tier.
A platform for playing 18xx games online!
Top fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 2README12pt
Expand with a description, install steps, usage, and examples.
- 3README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- 4README12pt
Show a quick-start snippet so contributors can see what using your project looks like.
Working through the fixes? Let every push regrade itself.
The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
52
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.
README is present.
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
Licensed under Other.
Engineering
90
Test files detected (spec).
Lockfile present (Gemfile.lock). Installs are reproducible.
CI is configured (.github/workflows/ruby.yml).
Ruby linting configured (.editorconfig).
Issue or PR templates present.
Project health
100
Dependency manifest found (Gemfile).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 233Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 361Watchers
Responsiveness
- 8hMedian issue response
- 1hMedian PR merge time
- 325Open issues
Repository files41 root entries
- .bundle
- .githubGood: CI is configured (.github/workflows/ruby.yml).Good: Issue or PR templates present.
- assets
- config
- db
- lib
- migrate
- models
- nginx
- public
- redis
- routes
- scripts
- specGood: Test files detected (spec).
- .dockerignore
- .editorconfigGood: Ruby linting configured (.editorconfig).
- .gitattributes
- .gitignoreGood: .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
- DockerfileGood: Environment pinned via Dockerfile.
- Dockerfile.amd64
- GemfileGood: Dependency manifest found (Gemfile).
- Gemfile.lockGood: Lockfile present (Gemfile.lock). Installs are reproducible.
- LICENSEGood: Licensed under Other.
- Makefile
- models.rb
- queue.rb
- Rakefile
- README.mdGood: 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
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/tobymao/18xx)