myzhang1029/penguin-rs
Grade a repo

0

/ 100

GradeD

Getting some notice. Tests and CI would be the fastest wins.

A fast TCP/UDP tunnel, transported over HTTP WebSocket

Documentation85
Engineering44
Health100
Rust47Apache-2.0today

Documentation

85

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

44

Tests18pt0

No tests detected anywhere in the repository.

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

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.

Reproducibility6pt82

Lockfile present (Cargo.lock). Installs are reproducible.

CI/CD14pt83

CI is configured (.github/workflows/rust-build.yml).

Linting and formatting5pt100

Rust linting configured (cargo clippy in CI).

Project health

100

Dependency manifest6pt100

Dependency manifest found (Cargo.toml).

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)
  • 3
    Forks
  • 10
    Releaseslatest today

Community

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

Responsiveness

  • 12h
    Median issue response
  • 4h
    Median PR merge time
  • 4
    Open issues
Repository files16 root entries
  • .config
  • .github
    Good: CI is configured (.github/workflows/rust-build.yml).
    Good: Dependabot configured for cargo.
  • fuzz
  • penguin
  • penguin-mux
  • tools
  • .clippy.toml
  • .codecov.yml
  • .gitignore
    Good: .gitignore present.
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • LICENSE.APACHE
    Good: Licensed under Apache-2.0.
  • LICENSE.GPL
  • logo.png
  • PROTOCOL.md
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.