realm/jazzy

0

/ 100

Documentation92
Engineering77
Health95
Ruby7,384MIT2mo ago
Grade a repo

A well-known project done right. Strong docs and solid engineering throughout.

Soulful docs for Swift & Objective-C

Documentation

92

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

77

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.

Reproducibility6pt70

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

Tests18pt80

Test files detected (spec).

CI/CD14pt100

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

Linting and formatting5pt100

Ruby linting configured (.rubocop.yml).

Project health

95

Activity5pt80

Actively maintained (pushed within 3 months).

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files20 root entries
  • .github
    Good: CI is configured (.github/workflows/Tests.yml).
  • bin
  • images
  • js
  • lib
  • spec
    Good: Test files detected (spec).
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • CHANGELOG.md
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • Dangerfile
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • jazzy.gemspec
  • LICENSE
    Good: Licensed under MIT.
  • ObjectiveC.md
  • 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.
  • SourceKitten