0
/ 100
Popular and well-maintained. A little polish away from elite status.
A C# port of shadowsocks
Top 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.
- 2README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- 3README12pt
Add CI/build status badges from shields.io or your CI provider to signal project health.
- 4Install and run instructions9pt
Add a section showing how to install dependencies.
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
66
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
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.
README is present.
Licensed under Other.
Engineering
70
No .NET formatter configured.
→ Add an .editorconfig to define C# formatting rules and run `dotnet format` in CI.
No dependency lockfile found (−70 pts).
→ Enable and commit packages.lock.json so NuGet restores are repeatable.
Test files detected (test).
CI is configured (appveyor.yml).
Issue or PR templates present.
Project health
79
No pushes in over a year (−80 pts).
→ A recent commit signals the project is alive and worth contributing to.
Dependency manifest found (shadowsocks-windows.sln).
Repository has a description.
.gitignore present.
Repository files15 root entries
- .githubGood: Issue or PR templates present.
- packaging
- shadowsocks-csharp
- testGood: Test files detected (test).
- .gitattributes
- .gitignoreGood: .gitignore present.
- appveyor.ymlGood: CI is configured (appveyor.yml).
- appveyor.yml.obsolete
- appveyor.yml.sample
- CHANGES
- CONTRIBUTING.mdIssue: 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.Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.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.Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
- LICENSE.txtGood: Licensed under Other.
- OPENSSL-GUIDE
- README.mdGood: README is present.Good: README is well structured with multiple sections.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.Good: README has code examples.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.Good: README documents how to run the project.
- shadowsocks-windows.slnGood: Dependency manifest found (shadowsocks-windows.sln).
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/shadowsocks/shadowsocks-windows)