puppetlabs/puppet

0

/ 100

Documentation64
Engineering68
Health89
Ruby7,889Apache-2.03mo ago
Grade a repo

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

Server automation framework and application

Documentation

64

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.

README12pt85

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

68

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 (acceptance/lib/puppet/acceptance/classifier_utils_spec.rb).

CI/CD14pt100

CI is configured (.github/workflows/checks.yaml).

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

Project health

89

Activity5pt60

Last pushed 3-6 months ago (−40 pts). A push within 90 days earns 80 pts; within 30 days earns 100 pts.

→ A recent commit keeps the project looking alive to visitors and contributors.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files34 root entries
  • .github
    Good: CI is configured (.github/workflows/checks.yaml).
  • acceptance
    Good: Test files detected (acceptance/lib/puppet/acceptance/classifier_utils_spec.rb).
  • api
  • benchmarks
  • bin
  • conf
  • docs
  • examples
  • ext
  • lib
  • locales
  • man
  • rakelib
  • references
  • spec
  • util
  • yardoc
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .mailmap
  • .noexec.yaml
  • .rubocop_todo.yml
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .yardopts
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CODEOWNERS
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Guardfile.example
  • install.rb
  • LICENSE
    Good: Licensed under Apache-2.0.
  • puppet.gemspec
  • 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.