shadowsocks/shadowsocks-windows

0

/ 100

Documentation66
Engineering70
Health79
C#59,565Other1y ago
Grade a repo

Popular and well-maintained. A little polish away from elite status.

A C# port of shadowsocks

Documentation

66

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

Contributing guide5pt55

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.

README12pt70

README is present.

License6pt100

Licensed under Other.

Engineering

70

Linting and formatting5pt0

No .NET formatter configured.

→ Add an .editorconfig to define C# formatting rules and run `dotnet format` in CI.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Enable and commit packages.lock.json so NuGet restores are repeatable.

Tests18pt80

Test files detected (test).

CI/CD14pt100

CI is configured (appveyor.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

79

Activity5pt20

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

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

Dependency manifest6pt100

Dependency manifest found (shadowsocks-windows.sln).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files15 root entries
  • .github
    Good: Issue or PR templates present.
  • packaging
  • shadowsocks-csharp
  • test
    Good: Test files detected (test).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • appveyor.yml
    Good: CI is configured (appveyor.yml).
  • appveyor.yml.obsolete
  • appveyor.yml.sample
  • CHANGES
  • 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.
    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.txt
    Good: Licensed under Other.
  • OPENSSL-GUIDE
  • README.md
    Good: 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.sln
    Good: Dependency manifest found (shadowsocks-windows.sln).