freecodecamp/devdocs

0

/ 100

Documentation85
Engineering86
Health100
Ruby39,085MPL-2.05d ago
Grade a repo

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

API Documentation Browser

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 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