basecamp/fizzy

0

/ 100

Documentation58
Engineering85
Health100
Ruby7,864Other6d ago
Grade a repo

Good community traction and solid fundamentals. Nearly in the top tier.

Kanban as it should be. Not as it has been.

Documentation

58

README12pt45

README is present.

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt61

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

License6pt100

Licensed under Other.

Engineering

85

CI/CD14pt72

CI is configured (.github/workflows/ci-checks.yml).

Tests18pt80

Test files detected (saas/test).

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

Reproducibility6pt100

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

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 files36 root entries
  • .claude
  • .github
    Good: CI is configured (.github/workflows/ci-checks.yml).
    Good: Dependabot covers 2 ecosystems (bundler, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • app
  • bin
  • config
  • db
  • docs
  • lib
  • log
  • public
  • saas
    Good: Test files detected (saas/test).
  • script
  • storage
  • test
  • tmp
  • vendor
  • .dockerignore
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitleaks.toml
  • .gitleaksignore
  • .mise.toml
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .ruby-version
  • AGENTS.md
  • config.ru
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • Gemfile.saas
  • Gemfile.saas.lock
  • LICENSE.md
    Good: Licensed under Other.
  • 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.
    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.
  • STYLE.md