0

/ 100

GradeF

Some interest. A stronger README and CI would help.

Documentation

19

README12pt0

README is present.

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.

License6pt100

A license file is present.

Engineering

41

Linting and formatting5pt0

No linter or formatter config found.

Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

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/CD14pt40

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

Tests18pt80

Test files detected (k3/luci-app-k3usb/files/root/usr/k3usb/test).

Project health

53

Dependency manifest6pt0

No dependency manifest detected at root.

Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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.

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

Community

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

Responsiveness

  • 2d 5h
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files54 root entries
  • .github
    Good: CI is configured (.github/workflows/Update.yml).
  • homelede
  • k3
    Good: A license file is present.
    Good: Test files detected (k3/luci-app-k3usb/files/root/usr/k3usb/test).
  • linkease
  • luci-app-adblock
  • luci-app-adguardhome
  • luci-app-advanced
  • luci-app-autotimeset
  • luci-app-cifs-mount
  • luci-app-diskman
  • luci-app-dnsfilter
  • luci-app-dockerman
  • luci-app-easymesh
  • luci-app-eqos
  • luci-app-idns
  • luci-app-ikoolproxy
  • luci-app-iperf3-server
  • luci-app-kodexplorer
  • luci-app-mac
  • luci-app-msd_lite
  • luci-app-nat6-helper
  • luci-app-netdata
  • luci-app-oled
  • luci-app-poweroff
  • luci-app-pushbot
  • luci-app-syncdial
  • luci-app-tailscale
  • luci-app-unblockneteasemusic
  • luci-app-wechatpush
  • luci-lib-docker
  • mhz
  • op-airpaly2
  • op-alist
  • op-aliyun
  • op-cpulimit
  • op-cupsd
  • op-ddnsgo
  • op-fileBrowser
  • op-filetransfer
  • op-go-aliyundrive
  • op-homebox
  • op-lucky
  • op-mosdns
  • op-npc
  • op-oaf
  • op-smartdns
  • op-socat
  • op-webdav
  • op-xunlei
  • patch
  • speedtestpp
  • theme
  • .gitignore
    Good: .gitignore present.
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    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.
    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.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.