0

/ 100

GradeF

Rough and inactive. Tests, CI, and a fuller README would revive it.

Higher than 42% 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 B (82).

See your top fixes
Now
F
57
Potential
B
82

Top fixes

Highest-impact changes first, ranked by point weight

16 to address
  1. 1
    Tests18pt

    Add *_test.go files alongside your packages and run `go test ./...`.

  2. 2
    README12pt

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

  3. 3
    README12pt

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

  4. 4
    README12pt

    Link to a deployed version, docs site, or demo video. Users want to see it running.

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

58

README12pt40

README is present.

Install and run instructions9pt45

No install instructions found in the README (−45 pts).

Add a section showing how to install dependencies.

Contributing guide5pt72

CONTRIBUTING guide found.

License6pt100

A license file is present.

Engineering

60

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.

Tests18pt30

Go module found but no *_test.go files detected.

Add *_test.go files alongside your packages and run `go test ./...`.

Reproducibility6pt85

Lockfile present (go.sum). Installs are reproducible.

CI/CD14pt100

CI is configured (vendor/github.com/cenkalti/backoff/v4/.travis.yml).

Linting and formatting5pt100

Formatting enforced (vendor/github.com/sirupsen/logrus/.golangci.yml).

Project health

49

Repository metadata5pt0

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.

Activity5pt5

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

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

Dependency manifest6pt100

Dependency manifest found (go.mod).

Housekeeping3pt100

.gitignore present.

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 files11 root entries
  • build
  • cmd
  • pkg
  • scripts
  • vendor
    Good: A license file is present.
    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 (vendor/github.com/cenkalti/backoff/v4/.travis.yml).
    Good: Formatting enforced (vendor/github.com/sirupsen/logrus/.golangci.yml).
  • .gitignore
    Good: .gitignore present.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • Makefile
  • 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.
    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.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
    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.
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/gouqi11/notify-plugins)](https://www.repo-grade.com/report/gouqi11/notify-plugins)

More graded repos