cloudfoundry/bytefmt

0

/ 100

Documentation52
Engineering68
Health92
Go225Apache-2.01d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

Human readable byte formatter

Documentation

52

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

README12pt58

README is present.

Contributing guide5pt72

CONTRIBUTING guide found.

License6pt100

Licensed under Apache-2.0.

Engineering

68

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

Reproducibility6pt75

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

Tests18pt100

Test files detected (benchmarks_test.go).

Linting and formatting5pt100

Formatting enforced (vendor/github.com/Masterminds/semver/v3/.golangci.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

92

Dependency manifest6pt75

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)
  • 32
    Forks
  • 78
    Releaseslatest 1y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 225
    Watchers

Responsiveness

  • —
    Median issue response
  • 7d 8h
    Median PR merge time
  • 0
    Open issues
Repository files15 root entries
  • .github
    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: Issue or PR templates present.
  • scripts
  • vendor
    Good: Formatting enforced (vendor/github.com/Masterminds/semver/v3/.golangci.yml).
    Good: Security policy present.
    Good: .gitignore present.
  • benchmarks_test.go
    Good: Test files detected (benchmarks_test.go).
  • bytes_test.go
  • bytes.go
  • CODEOWNERS
  • formatters_suite_test.go
  • 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.
  • NOTICE
  • package.go
  • 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.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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.
  • staticcheck.conf