ankane/searchkick

0

/ 100

Documentation85
Engineering66
Health100
Ruby6,716MIT19d ago
Grade a repo

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

Intelligent search made easy

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

66

Linting and formatting5pt0

No RuboCop config found.

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

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

Tests18pt80

Test files detected (test).

CI/CD14pt85

CI is configured (.github/workflows/build.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 files13 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Issue or PR templates present.
  • benchmark
  • examples
  • gemfiles
  • lib
  • test
    Good: Test files detected (test).
  • .gitignore
    Good: .gitignore present.
  • CHANGELOG.md
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE.txt
    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.
  • searchkick.gemspec