basecamp/kamal

0

/ 100

Documentation57
Engineering71
Health100
Ruby14,326MIT6d ago
Grade a repo

Popular and well-maintained. A little polish away from elite status.

Deploy web apps anywhere.

Documentation

57

README12pt38

README is present.

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt72

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

71

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.

CI/CD14pt72

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

Tests18pt80

Test files detected (bin/test).

Reproducibility6pt92

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

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 files15 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot configured for github-actions.
  • bin
    Good: Test files detected (bin/test).
  • gemfiles
  • lib
  • test
  • .gitignore
    Good: .gitignore present.
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
  • kamal.gemspec
  • MIT-LICENSE
  • 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 some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
    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.