gollum/gollum
Grade a repo

0

/ 100

GradeB

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Top 22% of 5,156 graded repos

A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.

Documentation96
Engineering78
Health84
Ruby14,279MIT8mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  4. 4
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

96

Install and run instructions9pt90

README documents how to install the project.

Contributing guide5pt92

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

78

Linting and formatting5pt0

No RuboCop config found.

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

Tests18pt80

Test files detected (test).

CI/CD14pt85

CI is configured (.github/workflows/test.yaml).

Reproducibility6pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

84

Activity5pt40

Last pushed 6-12 months ago (−60 pts).

→ A recent commit signals the project is still maintained.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yaml).
    Good: Dependabot covers 3 ecosystems (bundler, github-actions, npm). Dependencies stay current.
    Good: Issue or PR templates present.
  • bin
  • contrib
  • lib
  • licenses
  • test
    Good: Test files detected (test).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • config.rb
  • config.ru
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    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.
    Good: Contributing guide includes code examples.
  • docker-run.sh
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • gollum.gemspec
  • HISTORY.md
  • LATEST_CHANGES.md
  • LICENSE
    Good: Licensed under MIT.
  • package.json
  • 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.
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/gollum/gollum)](https://www.repo-grade.com/report/gollum/gollum)

More graded Ruby repos