galihru/hbd

0

/ 100

Documentation66
Engineering68
Health84
JavaScript14MIT3d ago
Grade a repo

Solid foundation. Invest in docs and CI to grow from here.

HAPPY BIRTHDAY: Happy Birthday Animation created using Javascript automation generation files

Documentation

66

Contributing guide5pt5

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.

Install and run instructions9pt45

README documents how to install the project.

README12pt90

README is present.

License6pt100

Licensed under MIT.

Engineering

68

Linting and formatting5pt0

No RuboCop config found.

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

CI/CD14pt57

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

Tests18pt80

Test files detected (spec).

Reproducibility6pt80

Lockfile present (package-lock.json). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

84

Housekeeping3pt0

No .gitignore found (−60 pts).

→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files51 root entries
  • _site
  • .github
    Good: CI is configured (.github/workflows/cloudflare.yml).
    Good: Issue or PR templates present.
  • lib
  • node_modules
    Issue: Build artifacts or local files may be committed (node_modules/.bin) (−40 pts).Fix: Remove them and add to .gitignore.
  • spec
    Good: Test files detected (spec).
  • 126693cc.js
  • _config.yml
  • _headers
  • .htaccess
  • .ruby-version
    Good: Environment pinned via .ruby-version.
  • 0056dc3f.js
  • 0aabff42.js
  • 126693cc.js
  • 192x192.png
  • 198x198.png
  • 512x512.png
  • 533210da.js
  • 58fcdf02.js
  • 81f270a1.js
  • 99a5361b.js
  • acf91514.js
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • e85802e3.js
  • firework.js
  • firework.min.js
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • google3fbea5d43709d99d.html
  • hbd-0.1.0.gem
  • hbd.gemspec
  • HBD.gemspec
  • hbd.jpg
  • hbd.mp3
  • index.html
  • LICENSE
    Good: Licensed under MIT.
  • LICENSE.txt
  • main.js
  • main.min.js
  • manifest.json
  • manifest.webmanifest
  • p5.js
  • p5.min.js
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
  • Rakefile
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • robots.txt
  • sc.js
  • SECURITY.md
    Good: Security policy present.
  • sw.js
  • worker.js
  • wrangler.toml