shablin/mtproto-proxy

0

/ 100

Documentation32
Engineering62
Health100
Python14MIT1d ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

🔄✨ MTProto Proxy for Telegram with automatic updates every 4 hours. Glory to Digital Resistance! ✊

Documentation

32

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.

README12pt35

README is present.

License6pt100

Licensed under MIT.

Engineering

62

Linting and formatting5pt0

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.

CI/CD14pt40

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

Reproducibility6pt70

Lockfile present (requirements.txt). Installs are reproducible.

Tests18pt80

Test files detected (tests).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 1
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 14
    Watchers

Responsiveness

  • 22h
    Median issue response
  • <1h
    Median PR merge time
  • 10
    Open issues
Repository files9 root entries
  • .github
    Good: CI is configured (.github/workflows/monitor.yml).
    Good: Issue or PR templates present.
  • data
  • src
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • LICENSE
    Good: Licensed under MIT.
  • main.py
  • 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.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).