marianoemarino/github-slideshow

0

/ 100

Documentation49
Engineering77
Health69
Ruby0MIT3y ago
Grade a repo

Rough and inactive. Tests, CI, and a fuller README would revive it.

A robot powered training repository :robot:

Documentation

49

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

README12pt50

README is present.

Contributing guide5pt72

CONTRIBUTING guide found.

License6pt100

Licensed under MIT.

Engineering

77

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.

Reproducibility6pt70

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

Tests18pt80

Test files detected (node_modules/reveal.js/test).

CI/CD14pt100

CI is configured (node_modules/reveal.js/.travis.yml).

Linting and formatting5pt100

Ruby linting configured (.editorconfig).

Project health

69

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • <1h
    Median issue response
  • 19h
    Median PR merge time
  • 3
    Open issues
Repository files15 root entries
  • _includes
  • _layouts
  • _posts
  • node_modules
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: Test files detected (node_modules/reveal.js/test).
    Good: CI is configured (node_modules/reveal.js/.travis.yml).
    Issue: Build artifacts or local files may be committed (node_modules/reveal.js) (−40 pts).Fix: Remove them and add to .gitignore.
  • script
  • _config.yml
  • .editorconfig
    Good: Ruby linting configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • index.html
  • LICENSE
    Good: Licensed under MIT.
  • package-lock.json
  • 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.
    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.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.