netchx/netch

0

/ 100

Documentation43
Engineering69
Health100
C#17,633GPL-3.06d ago
Grade a repo

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

A simple proxy client

Documentation

43

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.

README12pt65

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

69

Linting and formatting5pt0

No .NET formatter configured.

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

CI/CD14pt57

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

Tests18pt80

Test files detected (Tests).

Reproducibility6pt90

Lockfile present (Other/aiodns/go.sum). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (Netch.sln).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot covers 3 ecosystems (github-actions, nuget, gomod). Dependencies stay current.
    Good: Issue or PR templates present.
  • Netch
  • Other
    Good: Lockfile present (Other/aiodns/go.sum). Installs are reproducible.
  • Redirector
  • RedirectorTester
  • RouteHelper
  • Storage
  • Tests
    Good: Test files detected (Tests).
  • .gitignore
    Good: .gitignore present.
  • build.ps1
  • clean.ps1
  • common.props
  • global.json
  • jetbrains.svg
  • LICENSE
    Good: Licensed under GPL-3.0.
  • Netch.sln
    Good: Dependency manifest found (Netch.sln).
  • 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.
    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.
  • sha256.ps1