projectblacklight/blacklight
Grade a repo

87

/ 100

GradeB

Polished and well engineered. Punching above its star count.

Top 18% of 5,156 graded repos

Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr) index.

Documentation92
Engineering82
Health94
Ruby787Other1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

10 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
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility6pt

    Commit Gemfile.lock so Bundler installs are repeatable.

  4. 4
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

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

92

Contributing guide5pt67

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Other.

Engineering

82

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

Tests18pt80

Test files detected (lib/generators/blacklight/templates/search_builder_spec.rb).

CI/CD14pt100

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 4 / 47
    Commits (30d / 90d)
  • 252
    Forks
  • 159
    Releaseslatest 12y ago

Community

  • 62% - Fair
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 787
    Watchers

Responsiveness

  • <1h
    Median issue response
  • 4h
    Median PR merge time
  • 195
    Open issues
Repository files27 root entries
  • .docker
    Good: Environment pinned via .docker/app/Dockerfile.
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Issue or PR templates present.
  • app
  • config
  • db
  • lib
    Good: Test files detected (lib/generators/blacklight/templates/search_builder_spec.rb).
  • spec
  • tasks
  • .dockerignore
  • .env
    Issue: Build artifacts or local files may be committed (.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitignore
    Good: .gitignore present.
  • .rspec
  • .rubocop_todo.yml
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .solr_wrapper.yml
  • .yardopts
  • blacklight.gemspec
  • compose.yaml
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    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.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE
    Good: Licensed under Other.
  • package.json
  • 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.
  • rollup.config.js
  • template.demo.rb
  • VERSION
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/projectblacklight/blacklight)](https://www.repo-grade.com/report/projectblacklight/blacklight)

More graded Ruby repos