2dust/v2rayn

0

/ 100

Documentation44
Engineering66
Health100
C#109,432GPL-3.05d ago
Grade a repo

Massive community, but the engineering fundamentals haven't kept pace with the star count.

A GUI client for Windows, Linux and macOS, support Xray and sing-box and others

Documentation

44

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.

README12pt68

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

66

Reproducibility6pt20

No dependency lockfile found (−70 pts).

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

CI/CD14pt40

CI is configured (.github/workflows/build-all.yml).

Tests18pt80

Test files detected (v2rayN/ServiceLib.Tests/CoreConfig/Context/CoreConfigContextBuilderTests.cs).

Linting and formatting5pt100

.NET formatting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (v2rayN/AmazTool/AmazTool.csproj).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/build-all.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, nuget). Dependencies stay current.
    Good: Issue or PR templates present.
  • v2rayN
    Good: Test files detected (v2rayN/ServiceLib.Tests/CoreConfig/Context/CoreConfigContextBuilderTests.cs).
    Good: Dependency manifest found (v2rayN/AmazTool/AmazTool.csproj).
  • .editorconfig
    Good: .NET formatting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • LICENSE
    Good: Licensed under GPL-3.0.
  • package-debian-loong.sh
  • package-debian-riscv.sh
  • package-debian.sh
  • package-osx.sh
  • package-rhel-loong.sh
  • package-rhel-riscv.sh
  • package-rhel.sh
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    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.