freecodecamp/devdocs
Grade a repo

88

/ 100

GradeB

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

Top 16% of 5,156 graded repos

API Documentation Browser

Documentation85
Engineering86
Health100
Ruby39,162MPL-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

10 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

85

Contributing guide5pt72

CONTRIBUTING guide found.

README12pt80

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MPL-2.0.

Engineering

86

Tests18pt80

Test files detected (test).

Reproducibility6pt80

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

CI/CD14pt85

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

Linting and formatting5pt100

Ruby linting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

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

  • 24 / 96
    Commits (30d / 90d)
  • 2,607
    Forks
  • 0
    Releases

Community

  • 87% - Good
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 39,162
    Watchers

Responsiveness

  • 2d 1h
    Median issue response
  • 5d 2h
    Median PR merge time
  • 232
    Open issues
Repository files30 root entries
  • .github
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: CI is configured (.github/workflows/build.yml).
    Good: Issue or PR templates present.
  • assets
  • docs
  • lib
  • public
  • test
    Good: Test files detected (test).
  • views
  • .dockerignore
  • .editorconfig
    Good: Ruby linting configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .image_optim.yml
  • .ruby-version
  • .slugignore
  • .tool-versions
  • config.ru
  • COPYRIGHT
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Dockerfile-alpine
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • LICENSE
    Good: Licensed under MPL-2.0.
  • newrelic.yml
  • package-lock.json
  • Procfile
  • Rakefile
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • renovate.json
  • techstack.md
  • techstack.yml
  • Thorfile
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/freecodecamp/devdocs)](https://www.repo-grade.com/report/freecodecamp/devdocs)

More graded Ruby repos