community/community

0

/ 100

Documentation53
Engineering31
Health91
Ruby8,447CC-BY-4.09d ago
Grade a repo

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

Public feedback discussions for: GitHub Mobile, GitHub Discussions, GitHub Codespaces, GitHub Sponsors, GitHub Issues and more!

Documentation

53

Contributing guide5pt5

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 instructions9pt45

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt55

README is present.

License6pt100

Licensed under CC-BY-4.0.

Engineering

31

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

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.

CI/CD14pt40

CI is configured (.github/workflows/close-incident-discussions.yml).

Reproducibility6pt80

Lockfile present (Gemfile.lock). Installs are reproducible.

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

Project health

91

Housekeeping3pt40

No .gitignore found (−60 pts).

→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files10 root entries
  • .github
    Good: CI is configured (.github/workflows/close-incident-discussions.yml).
  • docs
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .ruby-version
    Good: Environment pinned via .ruby-version.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • LICENSE
    Good: Licensed under CC-BY-4.0.
  • LICENSE-CODE
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.