Getting noticed, but rough fundamentals could turn visitors away.
Egern、Stash、Surge、Loon、Quanx、Shadowrocket等自用配置。网上搜集，仅供参考！感谢大佬们的无私分享！
Documentation
14
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
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 is present.
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_AdBlock.yaml).
Lockfile present (Egern/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 (Egern/requirements.txt).
Repository has a description.
Actively maintained (pushed within the last month).
Repository files14 root entries
- .githubGood: CI is configured (.github/workflows/update_AdBlock.yaml).
- Clash
- EgernGood: Lockfile present (Egern/requirements.txt). Installs are reproducible.Good: Dependency manifest found (Egern/requirements.txt).
- image
- Loon
- QuantumultX
- Script
- Shadowrocket
- Stash
- Surge
- merge_rules.py
- nodes.txt
- README.mdGood: 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.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.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.
- TikTokUnlock_README.md