xtoolkit/tvc
Grade a repo

0

/ 100

GradeF

Some interest. A stronger README and CI would help.

Higher than 21% of 5,156 graded repos

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to D (62).

See your top fixes
Now
F
31
Potential
D
62

Top fixes

Highest-impact changes first, ranked by point weight

22 to address
  1. 1
    Tests18pt

    Add automated tests. They prove the code works and give contributors confidence to make changes.

  2. 2
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

    Add `pull_request:` to the workflow `on:` triggers.

  4. 4
    CI/CD14pt

    Add a lint step to catch style issues automatically.

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.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

53

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.

Install and run instructions9pt45

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

Add a section showing how to install dependencies.

README12pt58

README is present.

License6pt100

Licensed under AGPL-3.0.

Engineering

11

Tests18pt0

No tests detected anywhere in the repository.

Add automated tests. They prove the code works and give contributors confidence to make changes.

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

Commit composer.lock so Composer installs are repeatable.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

CI/CD14pt40

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

Project health

43

Dependency manifest6pt0

No dependency manifest detected at root.

Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Housekeeping3pt40

No .gitignore found (−60 pts).

Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 457 / 2345
    Commits (30d / 90d)
  • 63
    Forks
  • -
    Releases

Community

  • 28% - Weak
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 11
    Watchers

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/php.yml).
  • api
  • channelsData
  • lite
  • subscriptions
  • channels.json
  • channelsAssets.php
  • config.txt
  • duplicate.php
  • functions.php
  • get.php
  • hiddifyWarp.php
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • README.md
    Good: README is present.
    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.
    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.
    Good: README documents how to run the project.
  • sort.php
  • structure.json
  • toClashSurfboard.php
  • toSingbox.php
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/xtoolkit/tvc)](https://www.repo-grade.com/report/xtoolkit/tvc)

More graded PHP repos