0

/ 100

GradeF

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

Higher than 23% of 5,156 graded repos

๐Ÿ“ข Various README templates & tips on writing high-quality documentation that people want to read.

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 (68).

See your top fixes
Now
F
34
Potential
D
68

Top fixes

Highest-impact changes first, ranked by point weight

17 to address
  1. 1
    Tests18pt

    Add automated tests. They prove the code works and give contributors confidence to make changes.

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

  3. 3
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

  4. 4
    Install and run instructions9pt

    Add a section showing how to install dependencies.

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

74

Install and run instructions9pt45

No install instructions found in the README (โˆ’45 pts).

โ†’ Add a section showing how to install dependencies.

Contributing guide5pt71

Contributing guide is too short for full depth credit (โˆ’6 pts). 400+ words earns the full +12 pts.

โ†’ Add setup instructions, code style notes, and how to run tests.

README12pt85

README is present.

License6pt100

Licensed under MIT.

Engineering

12

Tests18pt0

No tests detected anywhere in the repository.

โ†’ Add automated tests. They prove the code works and give contributors confidence to make changes.

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.

Linting and formatting5pt0

No linter or formatter config found.

โ†’ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Reproducibility6pt0

No dependency lockfile found (โˆ’70 pts).

โ†’ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

23

Dependency manifest6pt0

No dependency manifest detected at root.

โ†’ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

Activity5pt5

No pushes in over 2 years. Looks unmaintained (โˆ’95 pts).

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

Housekeeping3pt40

No .gitignore found (โˆ’60 pts).

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

Repository metadata5pt60

Repository has a description.

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 files10 root entries
  • .github
    Good: Issue or PR templates present.
  • README Templates
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Good: README includes status badges.
    Issue: No install instructions found in the README (โˆ’45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CODEBASE_STRUCTURE.md
  • CODING_GUIDELINES.md
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (โˆ’6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (โˆ’12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (โˆ’8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (โˆ’8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • LICENSE
    Good: Licensed under MIT.
  • PULL_REQUEST_TEMPLATE.md
  • README.md
  • TODO.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/toantran-ea/the-documentation-compendium)](https://www.repo-grade.com/report/toantran-ea/the-documentation-compendium)

More graded repos