53
/ 100
Popular for its size, but the engineering basics lag behind the interest.
A powerful tool to automatically download, parse, and organize VPN configurations (VLESS, VMess, Shadowsocks, etc.) and push updates to GitHub.
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 B (80).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add automated tests. They prove the code works and give contributors confidence to make changes.
- 2CI/CD14pt
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add `pull_request:` to the workflow `on:` triggers.
- 4CI/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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
82
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.
README documents how to install the project.
README is present.
Licensed under GPL-3.0.
Engineering
20
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
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.
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 is configured (.github/workflows/update-vpn-configs.yml).
Lockfile present (source/requirements.txt). Installs are reproducible.
Project health
91
No .gitignore found (−60 pts).
→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.
Dependency manifest found (source/requirements.txt).
Repository has a description.
Actively maintained (pushed within the last month).
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 72Forks
- 2Releaseslatest 11mo ago
Community
- 42% - WeakCommunity health
- -authors own >50% of commits
- 234Watchers
Responsiveness
- <1hMedian issue response
- -Median PR merge time
- 1Open issues
Repository files9 root entries
- .githubGood: CI is configured (.github/workflows/update-vpn-configs.yml).
- configs
- docs
- sourceGood: Lockfile present (source/requirements.txt). Installs are reproducible.Good: Dependency manifest found (source/requirements.txt).
- LICENSEGood: Licensed under GPL-3.0.
- README_FA.mdGood: README is present.Good: README is well structured with multiple sections.Good: README includes screenshots or visuals. Great for first impressions.Good: README has code examples.Good: README links to a live demo or deployed app.Good: README includes status badges.Good: README documents how to install the project.Good: README documents how to run the project.
- README_ru.md
- README_zh.md
- README.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/shatakvpn/configforge-v2ray)