github/markup

0

/ 100

Documentation76
Engineering65
Health100
Ruby6,036MIT7d ago
Grade a repo

Good community traction and solid fundamentals. Nearly in the top tier.

Determines which markup library to use to render a content file (e.g. README) on GitHub

Documentation

76

README12pt55

README is present.

Contributing guide5pt74

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.

License6pt100

Licensed under MIT.

Engineering

65

Linting and formatting5pt0

No RuboCop config found.

→ Add a .rubocop.yml and run `rubocop` in CI to enforce consistent Ruby style.

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.

Tests18pt80

Test files detected (test).

CI/CD14pt85

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

Reproducibility6pt90

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

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 files16 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (bundler, github-actions). Dependencies stay current.
  • bin
  • lib
  • script
  • test
    Good: Test files detected (test).
  • .gitignore
    Good: .gitignore present.
  • .kick
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • 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.
    Good: Contributing guide explains how to run tests.
    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).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • github-markup.gemspec
  • HISTORY.md
  • LICENSE
    Good: Licensed under MIT.
  • Rakefile
  • README.md
    Good: README is present.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.