0

/ 100

GradeF

Lots of room to improve. Start with a README and CI.

Higher than 31% of 5,156 graded repos

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 D (62).

See your top fixes
Now
F
45
Potential
D
62

Top fixes

Highest-impact changes first, ranked by point weight

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

    Add an Overview, Install, Usage, and Contributing section at minimum.

  3. 3
    README12pt

    Add more sections (Overview, Install, Usage, Contributing) using ## 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

23

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.

README12pt28

README is present.

Install and run instructions9pt45

README documents how to install the project.

Engineering

59

Linting and formatting5pt0

No linter or formatter found.

Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.

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.

Tests18pt80

A test script is configured in package.json.

CI/CD14pt100

CI is configured (Jenkinsfile).

Project health

44

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

A recent commit signals the project is alive and worth using.

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Housekeeping3pt40

No .gitignore found (−60 pts).

Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Dependency manifest6pt83

Dependency manifest found (package.json).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

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

Community

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

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files6 root entries
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Jenkinsfile
    Good: CI is configured (Jenkinsfile).
  • main.js
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## 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.
    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.
  • test.js
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/kuldeep-21/devops-tutorial)](https://www.repo-grade.com/report/kuldeep-21/devops-tutorial)

More graded JavaScript repos