0

/ 100

GradeF

Early-stage engineering. The fastest wins are CI and the README.

Higher than 39% of 5,156 graded repos

Set up a modern web app by running one command.

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 C (75).

See your top fixes
Now
F
54
Potential
C
75

Top fixes

Highest-impact changes first, ranked by point weight

18 to address
  1. 1
    CI/CD14pt

    If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

  2. 2
    README12pt

    Expand with a description, install steps, usage, and examples.

  3. 3
    README12pt

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

  4. 4
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

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

42

License6pt0

No license detected.

Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

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 instructions9pt90

README documents how to install the project.

Engineering

48

CI/CD14pt0

No CI configuration detected in this repository.

If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

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.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

Commit package-lock.json, pnpm-lock.yaml, yarn.lock, or bun.lock so Node installs are repeatable.

Tests18pt100

Test script and framework are configured in package.json.

Linting and formatting5pt100

Linter or formatter configured (.eslintrc).

Project health

87

Dependency manifest6pt75

Dependency manifest found (package.json).

Activity5pt80

Actively maintained (pushed within 3 months).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 0 / 1
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 0
    Watchers

Responsiveness

  • -
    Median issue response
  • <1h
    Median PR merge time
  • 3
    Open issues
Repository files9 root entries
  • .github
  • .dockerignore
  • .eslintrc
    Good: Linter or formatter configured (.eslintrc).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • app.js
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.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.
    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.
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/finaljrad-ir/scout-demo-service)](https://www.repo-grade.com/report/finaljrad-ir/scout-demo-service)

More graded Dockerfile repos