tilfin/ougai

0

/ 100

Documentation82
Engineering49
Health100
Ruby277MIT1d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

A Ruby structured logging is capable of handling a message, custom data or an exception easily and generates JSON or human readable logs.

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

49

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.

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/CD14pt68

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

Tests18pt80

Test files detected (spec).

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)
  • 23
    Forks
  • 40
    Releaseslatest 8y ago

Community

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

Responsiveness

  • <1h
    Median issue response
  • <1h
    Median PR merge time
  • 13
    Open issues
Repository files10 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • lib
  • spec
    Good: Test files detected (spec).
  • .gitignore
    Good: .gitignore present.
  • .rspec
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE.txt
    Good: Licensed under MIT.
  • ougai.gemspec
  • 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.