rspeicher/slack-ruby-block-kit
Grade a repo

0

/ 100

GradeC

Solid engineering. The main gap is visibility.

Top 46% of 5,156 graded repos

A ruby wrapper for Slack's Block Kit

Documentation73
Engineering70
Health64
0MIT5y ago

Top fixes

Highest-impact changes first, ranked by point weight

12 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 section showing how to start or use the project.

  3. 3
    Install and run instructions9pt

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

  4. 4
    Reproducibility6pt

    Commit Gemfile.lock so Bundler installs are repeatable.

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

73

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 instructions9pt45

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

70

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.

Reproducibility6pt12

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

Tests18pt80

Test files detected (spec).

CI/CD14pt100

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

Project health

64

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

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

Repository metadata5pt60

Repository has a description.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 0
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files14 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot configured for bundler.
  • bin
  • lib
  • spec
    Good: Test files detected (spec).
  • .deepsource.toml
  • .gitignore
    Good: .gitignore present.
  • .rspec
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • slack-ruby-block-kit.gemspec
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/rspeicher/slack-ruby-block-kit)](https://www.repo-grade.com/report/rspeicher/slack-ruby-block-kit)

More graded repos