0
/ 100
Strong community interest, but docs and engineering haven't caught up to the hype.
Next Generation of ShadowsocksX
A low grade is a to-do list, not a judgment of your code
Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to D (66).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 2CI/CD14pt
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add a lint step to catch style issues automatically.
- 4CI/CD14pt
Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
55
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
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.
README is present.
Licensed under GPL-3.0.
Engineering
58
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.
No dependency lockfile found (−70 pts).
→ Commit Package.resolved for application projects so Swift Package Manager resolves the same versions.
CI is configured (.github/workflows/feature.yml).
Test files detected (Pods/RxSwift/RxSwift/Observables/CombineLatest.swift).
Issue or PR templates present.
Project health
47
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.
No pushes in over a year (−80 pts).
→ A recent commit signals the project is alive and worth contributing to.
Repository has a description.
.gitignore present.
Repository files18 root entries
- .githubGood: CI is configured (.github/workflows/feature.yml).Good: Issue or PR templates present.
- deps
- LaunchHelper
- PodsGood: Test files detected (Pods/RxSwift/RxSwift/Observables/CombineLatest.swift).
- proxy_conf_helper
- ShadowsocksX-NG
- ShadowsocksX-NG.xcodeproj
- ShadowsocksX-NG.xcworkspace
- ShadowsocksX-NGTests
- _config.yml
- .gitignoreGood: .gitignore present.
- .gitmodules
- genstrings.py
- LICENSEGood: Licensed under GPL-3.0.
- Makefile
- Podfile
- Podfile.lock
- README.mdGood: 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.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/shadowsocks/shadowsocksx-ng)