shadowsocks/shadowsocksx-ng

0

/ 100

Documentation55
Engineering58
Health47
Swift32,890GPL-3.01y ago
Grade a repo

Strong community interest, but docs and engineering haven't caught up to the hype.

Next Generation of ShadowsocksX

Documentation

55

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

README12pt85

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

58

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 Package.resolved for application projects so Swift Package Manager resolves the same versions.

CI/CD14pt57

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

Tests18pt80

Test files detected (Pods/RxSwift/RxSwift/Observables/CombineLatest.swift).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

47

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.

Activity5pt20

No pushes in over a year (−80 pts).

→ A recent commit signals the project is alive and worth contributing to.

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/feature.yml).
    Good: Issue or PR templates present.
  • deps
  • LaunchHelper
  • Pods
    Good: Test files detected (Pods/RxSwift/RxSwift/Observables/CombineLatest.swift).
  • proxy_conf_helper
  • ShadowsocksX-NG
  • ShadowsocksX-NG.xcodeproj
  • ShadowsocksX-NG.xcworkspace
  • ShadowsocksX-NGTests
  • _config.yml
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • genstrings.py
  • LICENSE
    Good: Licensed under GPL-3.0.
  • Makefile
  • Podfile
  • Podfile.lock
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README includes status badges.
    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.