shopify/liquid

0

/ 100

Documentation91
Engineering67
Health100
Ruby11,812MIT8d ago
Grade a repo

Popular and well-maintained. A little polish away from elite status.

Liquid markup language. Safe, customer facing template language for flexible web apps.

Documentation

91

Contributing guide5pt61

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

67

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.

Reproducibility6pt22

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

Tests18pt80

Test files detected (performance/tests).

CI/CD14pt85

CI is configured (.github/workflows/cla.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 files18 root entries
  • .github
    Good: CI is configured (.github/workflows/cla.yml).
    Good: Dependabot configured for github-actions.
  • bin
  • example
  • lib
  • performance
    Good: Test files detected (performance/tests).
  • spec
  • test
  • .gitignore
    Good: .gitignore present.
  • .rubocop_todo.yml
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .ruby-version
    Good: Environment pinned via .ruby-version.
  • 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.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • History.md
  • LICENSE
    Good: Licensed under MIT.
  • liquid.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.