github/elastomer-client

0

/ 100

Documentation82
Engineering72
Health100
Ruby196MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

A library for interacting with Elasticsearch

Documentation

82

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

72

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.

Reproducibility6pt30

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

Tests18pt80

Test files detected (lib/elastomer_client/client/rest_api_spec.rb).

CI/CD14pt100

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

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 health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 25
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 196
    Watchers

Responsiveness

  • 17h
    Median issue response
  • 16h
    Median PR merge time
  • 13
    Open issues
Repository files17 root entries
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/main.yml).
    Good: Dependabot covers 2 ecosystems (bundler, github-actions). Dependencies stay current.
  • docker
    Good: Environment pinned via docker/compose.yaml.
  • docs
  • gemfiles
  • lib
    Good: Test files detected (lib/elastomer_client/client/rest_api_spec.rb).
  • script
  • test
  • .gitignore
    Good: .gitignore present.
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .ruby-version
  • CHANGELOG.md
  • elastomer-client.gemspec
  • 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.