ddollar/foreman

0

/ 100

Documentation63
Engineering54
Health84
Ruby6,153MIT11mo ago
Grade a repo

Strong community interest, but tests, CI, or docs need work.

Manage Procfile-based applications

Documentation

63

Contributing guide5pt0

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.

README12pt85

README is present.

License6pt100

Licensed under MIT.

Engineering

54

Linting and formatting5pt0

No RuboCop config found.

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

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

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.

Tests18pt80

Test files detected (spec).

CI/CD14pt85

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

Project health

84

Activity5pt40

Last pushed 6-12 months ago (−60 pts).

→ A recent commit signals the project is still maintained.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files16 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • bin
  • data
  • dist
  • lib
  • man
  • pkg
  • spec
    Good: Test files detected (spec).
  • tasks
  • .gitignore
    Good: .gitignore present.
  • Changelog.md
  • foreman.gemspec
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    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.
    Good: README includes status badges.
    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.