Lots of room to improve. Start with a README and CI.
Documentation
0
README is present.
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
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.
Engineering
39
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
No RuboCop config found.
→ Add a .rubocop.yml and run `rubocop` in CI to enforce consistent Ruby style.
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.
Test files detected (test).
Lockfile present (Gemfile.lock). Installs are reproducible.
Project health
59
No pushes in over 2 years. Looks unmaintained (−95 pts).
→ A recent commit signals the project is alive and worth using.
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 manifest found (Gemfile).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 0Watchers
Responsiveness
- —Median issue response
- —Median PR merge time
- 0Open issues
Repository files24 root entries
- app
- bin
- config
- db
- lib
- log
- public
- storage
- testGood: Test files detected (test).
- tmp
- vendor
- .browserslistrc
- .gitattributes
- .gitignoreGood: .gitignore present.
- .ruby-versionGood: Environment pinned via .ruby-version.
- babel.config.js
- config.ru
- GemfileGood: Dependency manifest found (Gemfile).
- Gemfile.lockGood: Lockfile present (Gemfile.lock). Installs are reproducible.
- package.json
- postcss.config.js
- Rakefile
- README.mdGood: README is present.Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown 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.Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.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.
- yarn.lock