faker-ruby/faker

0

/ 100

Documentation85
Engineering91
Health100
Ruby11,619MIT8d ago
Grade a repo

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

A library for generating fake data such as names, addresses, and phone numbers.

Documentation

85

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt92

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

91

Tests18pt80

Test files detected (test).

Reproducibility6pt90

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

CI/CD14pt100

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

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 files24 root entries
  • .github
    Good: CI is configured (.github/workflows/ruby.yml).
    Good: Dependabot covers 2 ecosystems (bundler, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • benchmark
  • bin
  • custom-hooks
  • doc
  • experiments
  • lib
  • script
  • tasks
  • test
    Good: Test files detected (test).
  • .gitignore
    Good: .gitignore present.
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .yardopts
  • CHANGELOG.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    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.
    Good: Contributing guide includes code examples.
  • faker.gemspec
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • GENERATORS.md
  • License.txt
    Good: Licensed under MIT.
  • MAINTAINING.md
  • Rakefile
  • README.md
    Good: README is present.
    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.
    Good: README has code examples.
    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.
  • SECURITY.md
    Good: Security policy present.