paper-trail-gem/paper_trail

0

/ 100

Documentation82
Engineering80
Health95
Ruby7,021MIT1mo ago
Grade a repo

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

Track changes to your rails models

Documentation

82

README12pt70

README is present.

Contributing guide5pt72

CONTRIBUTING guide found.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

80

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

Tests18pt80

Test files detected (spec).

CI/CD14pt100

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

Issue and PR templates6pt100

Issue or PR templates present.

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 files16 root entries
  • .github
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: CI is configured (.github/workflows/test.yml).
    Good: Issue or PR templates present.
  • doc
  • gemfiles
  • lib
  • spec
    Good: Test files detected (spec).
  • .gitignore
    Good: .gitignore present.
  • .rspec
  • .rubocop_todo.yml
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • Appraisals
  • CHANGELOG.md
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE
    Good: Licensed under MIT.
  • paper_trail.gemspec
  • 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.