iawia002/lux
Grade a repo

95

/ 100

GradeA

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Top 6% of 5,156 graded repos

👾 Fast and simple video download library and CLI tool written in Go

Documentation92
Engineering97
Health95
Go31,449MIT4mo ago

Outstanding. A score of 95/100 puts this repo in a very small tier of truly well-engineered projects.

Top fixes

Highest-impact changes first, ranked by point weight

8 to address
  1. 1
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  2. 2
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

  3. 3
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  4. 4
    Contributing guide5pt

    Add setup instructions, code style notes, and how to run tests.

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

92

Contributing guide5pt68

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

97

Reproducibility6pt75

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

Tests18pt100

Test files detected (downloader/downloader_test.go).

CI/CD14pt100

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

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

95

Activity5pt80

Actively maintained (pushed within 3 months).

Dependency manifest6pt100

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 0 / 0
    Commits (30d / 90d)
  • 3,305
    Forks
  • 86
    Releaseslatest 8y ago

Community

  • 71% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 31,449
    Watchers

Responsiveness

  • <1h
    Median issue response
  • <1h
    Median PR merge time
  • 545
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/builder.yml).
    Good: Issue or PR templates present.
  • app
  • config
  • downloader
    Good: Test files detected (downloader/downloader_test.go).
  • extractors
  • parser
  • request
  • script
  • test
  • utils
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • .goreleaser.yml
  • Cask.toml
  • codecov.yml
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under MIT.
  • main.go
  • 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.
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/iawia002/lux)](https://www.repo-grade.com/report/iawia002/lux)

More graded Go repos