bettererrors/better_errors
Grade a repo

0

/ 100

GradeD

Strong community interest, but tests, CI, or docs need work.

Top 47% of 5,156 graded repos

Better error page for Rack apps

Documentation85
Engineering55
Health79
Ruby6,869MIT2y ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to C (76).

See your top fixes
Now
D
69
Potential
C
76

Top fixes

Highest-impact changes first, ranked by point weight

13 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  4. 4
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

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.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

85

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

55

Linting and formatting5pt0

No RuboCop config found.

→ Add a .rubocop.yml and run `rubocop` in CI to enforce consistent Ruby style.

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.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

Tests18pt80

Test files detected (spec).

CI/CD14pt85

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

Project health

79

Activity5pt20

No pushes in over a year (−80 pts).

→ A recent commit signals the project is alive and worth contributing to.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • feature-screenshots
  • gemfiles
  • lib
  • spec
    Good: Test files detected (spec).
  • .coveralls.yml
  • .gitignore
    Good: .gitignore present.
  • .ruby-version
    Good: Environment pinned via .ruby-version.
  • .yardopts
  • better_errors.gemspec
  • CHANGELOG.md
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE
    Good: Licensed under MIT.
  • 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.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/bettererrors/better_errors)](https://www.repo-grade.com/report/bettererrors/better_errors)

More graded Ruby repos