vulcand/oxy
Grade a repo

0

/ 100

GradeC

Good community traction and solid fundamentals. Nearly in the top tier.

Top 38% of 5,156 graded repos

Go middlewares for HTTP servers & proxies

Documentation47
Engineering85
Health100
Go2,106Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    README12pt

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

  2. 2
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  3. 3
    Install and run instructions9pt

    Add a section showing how to install dependencies.

  4. 4
    Install and run instructions9pt

    Add a section showing how to start or use the project.

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

47

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.

README12pt75

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

85

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.

Tests18pt100

Test files detected (buffer/buffer_test.go).

CI/CD14pt100

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

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

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)
  • 331
    Forks
  • 0
    Releases

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 2,106
    Watchers

Responsiveness

  • 4d 23h
    Median issue response
  • 3h
    Median PR merge time
  • 32
    Open issues
Repository files20 root entries
  • .github
    Good: CI is configured (.github/workflows/go-cross.yml).
  • buffer
    Good: Test files detected (buffer/buffer_test.go).
  • cbreaker
  • connlimit
  • forward
  • internal
  • memmetrics
  • ratelimit
  • roundrobin
  • stream
  • testutils
  • trace
  • utils
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • 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.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use 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/vulcand/oxy)](https://www.repo-grade.com/report/vulcand/oxy)

More graded Go repos