openai/tunnel-client
Grade a repo

75

/ 100

GradeC

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

Top 39% of 5,156 graded repos
Documentation70
Engineering77
Health76
Go115Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

14 to address
  1. 1
    CI/CD14pt

    Add `pull_request:` to the workflow `on:` triggers.

  2. 2
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

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

  4. 4
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

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

70

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.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

77

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.

CI/CD14pt68

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

Reproducibility6pt85

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

Tests18pt100

Test files detected (adminui/src/components/__tests__).

Linting and formatting5pt100

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

Project health

76

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.

Dependency manifest6pt75

Dependency manifest found (go.mod).

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 40 / 163
    Commits (30d / 90d)
  • 20
    Forks
  • 9
    Releaseslatest 2mo ago

Community

  • 25% - Weak
    Community health
  • -
    authors own >50% of commits
  • 115
    Watchers

Responsiveness

  • -
    Median issue response
  • 13h
    Median PR merge time
  • 0
    Open issues
Repository files22 root entries
  • .codex
  • .github
    Good: CI is configured (.github/workflows/release.yml).
  • adminui
    Good: Test files detected (adminui/src/components/__tests__).
  • cmd
  • docs
  • e2e
  • examples
  • pkg
  • plugins
  • scripts
  • testsupport
  • wrappers
  • .dockerignore
  • .gitattributes
  • .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.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • Makefile
  • NOTICE
  • README.md
    Good: README is present.
    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.
    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.
    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/openai/tunnel-client)](https://www.repo-grade.com/report/openai/tunnel-client)

More graded Go repos