lewagon/setup
Grade a repo

0

/ 100

GradeD

Strong community interest, but docs and engineering haven't caught up to the hype.

Higher than 48% of 5,156 graded repos

Setup instructions for Le Wagon's students on their first day of AI Software Development Bootcamp

Documentation48
Engineering61
Health100
Ruby19,5982mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (83).

See your top fixes
Now
D
64
Potential
B
83

Top fixes

Highest-impact changes first, ranked by point weight

17 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 step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

    Add `pull_request:` to the workflow `on:` triggers.

  4. 4
    CI/CD14pt

    Add a lint step to catch style issues automatically.

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

48

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

README12pt45

README is present.

Install and run instructions9pt45

README documents how to install the project.

License6pt100

A license file is present.

Engineering

61

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.

CI/CD14pt40

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

Tests18pt80

Test files detected (lib/build_spec.rb).

Reproducibility6pt80

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

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 files37 root entries
  • _partials
  • .github
    Good: CI is configured (.github/workflows/build.yml).
  • builds
  • constants
  • doc
  • docs
  • images
  • lib
    Good: Test files detected (lib/build_spec.rb).
  • utils
  • .gitignore
    Good: .gitignore present.
  • .rubocop.yml
    Good: Ruby linting configured (.rubocop.yml).
  • .ruby-version
    Good: Environment pinned via .ruby-version.
  • build.rb
  • check.rb
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • Gemfile.lock
    Good: Lockfile present (Gemfile.lock). Installs are reproducible.
  • LICENSE
    Good: A license file is present.
  • macos.cn.md
  • macos.es.md
  • macos.fr.md
  • macos.md
  • macos.pt.md
  • README.cn.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • README.es.md
  • README.fr.md
  • README.md
  • README.pt.md
  • ubuntu.cn.md
  • ubuntu.es.md
  • ubuntu.fr.md
  • ubuntu.md
  • ubuntu.pt.md
  • windows.cn.md
  • windows.es.md
  • windows.fr.md
  • windows.md
  • windows.pt.md
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/lewagon/setup)](https://www.repo-grade.com/report/lewagon/setup)

More graded Ruby repos