0
/ 100
Good community traction and solid fundamentals. Nearly in the top tier.
Track changes to your rails models
Top fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 2README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- 3README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
- 4Install and run instructions9pt
Add a .env.example listing all required environment variables so contributors know what to set up.
Working through the fixes? Let every push regrade itself.
The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
82
README is present.
CONTRIBUTING guide found.
README documents how to install the project.
Licensed under MIT.
Engineering
80
No dependency lockfile found (−70 pts).
→ Commit Gemfile.lock so Bundler installs are repeatable.
Test files detected (spec).
CI is configured (.github/workflows/test.yml).
Ruby linting configured (.rubocop.yml).
Issue or PR templates present.
Project health
95
Actively maintained (pushed within 3 months).
Dependency manifest found (Gemfile).
Repository has a description.
.gitignore present.
Repository files16 root entries
- .githubGood: 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
- specGood: Test files detected (spec).
- .gitignoreGood: .gitignore present.
- .rspec
- .rubocop_todo.yml
- .rubocop.ymlGood: Ruby linting configured (.rubocop.yml).
- Appraisals
- CHANGELOG.md
- GemfileGood: Dependency manifest found (Gemfile).
- LICENSEGood: Licensed under MIT.
- paper_trail.gemspec
- Rakefile
- README.mdGood: 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.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/paper-trail-gem/paper_trail)