go-test/deep
Grade a repo

0

/ 100

GradeC

Good shape overall. A few tweaks would push it into the top tier.

Top 39% of 5,156 graded repos

Golang deep variable equality test that returns human-readable differences

Documentation51
Engineering80
Health100
Go789MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    README12pt

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

  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

51

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

README12pt85

README is present.

License6pt100

Licensed under MIT.

Engineering

80

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.

Reproducibility6pt75

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

CI/CD14pt85

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

Tests18pt100

Test files detected (deep_test.go).

Linting and formatting5pt100

Formatting enforced (gofmt (built into Go toolchain)).

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 56
    Forks
  • 3
    Releaseslatest 2y ago

Community

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

Responsiveness

  • 13d 16h
    Median issue response
  • 17h
    Median PR merge time
  • 12
    Open issues
Repository files11 root entries
  • .github
    Good: CI is configured (.github/workflows/go.yml).
  • test
  • .gitignore
    Good: .gitignore present.
  • CHANGES.md
  • deep_test.go
    Good: Test files detected (deep_test.go).
  • deep.go
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under MIT.
  • README.md
    Good: README is present.
    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.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SECURITY.md
    Good: Security policy present.
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/go-test/deep)](https://www.repo-grade.com/report/go-test/deep)

More graded Go repos