jordansissel/fpm

0

/ 100

Documentation72
Engineering74
Health95
Ruby11,481Other2mo ago
Grade a repo

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

Effing package management! Build packages for multiple platforms (deb, rpm, etc) with great ease and sanity.

Documentation

72

README12pt40

README is present.

Contributing guide5pt84

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

74

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).

Reproducibility6pt80

Lockfile present (requirements.txt). Installs are reproducible.

CI/CD14pt85

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

Project health

95

Activity5pt80

Actively maintained (pushed within 3 months).

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files24 root entries
  • .github
    Good: CI is configured (.github/workflows/ruby.yml).
  • bin
  • docs
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    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.
  • lib
  • spec
    Good: Test files detected (spec).
  • templates
  • test
  • .gitignore
    Good: .gitignore present.
  • .readthedocs.yaml
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • Brewfile
  • CHANGELOG.rst
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTORS
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • fpm.gemspec
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE
    Good: Licensed under Other.
  • Makefile
  • notify-failure.sh
  • README.rst
    Good: README is present.
    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.
    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.
    Good: README documents how to run the project.
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
  • singularity.def
  • Vagrantfile