felixonmars/dnsmasq-china-list

0

/ 100

Documentation57
Engineering46
Health59
Ruby6,074Other6d ago
Grade a repo

Strong community interest, but tests, CI, or docs need work.

Chinese-specific configuration to improve your favorite DNS server. Best partner for chnroutes.

Documentation

57

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.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

46

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 Gemfile.lock so Bundler 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/CD14pt57

CI is configured (.github/workflows/test.yaml).

Tests18pt80

Test files detected (test).

Project health

59

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.

Housekeeping3pt40

No .gitignore found (−60 pts).

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

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files20 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yaml).
  • test
    Good: Test files detected (test).
  • accelerated-domains.china.conf
  • apple.china.conf
  • autoupdater.rb
  • bogus-nxdomain.china.conf
  • cdn-testlist.txt
  • dnsmasq-update-china-list
  • find_redundant.rb
  • gems.rb
  • google.china.conf
  • install.sh
  • LICENSE
    Good: Licensed under Other.
  • Makefile
  • ns-blacklist.txt
  • ns-whitelist.txt
  • README.md
    Good: README is present.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown 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.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • removed-cdn.txt
  • updater.rb
  • verify.rb