xos/config

0

/ 100

Documentation26
Engineering62
Health73
JavaScript1821d ago
Grade a repo

Popular for its size, but the engineering basics lag behind the interest.

私人物品

Documentation

26

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

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.

README12pt68

README is present.

Engineering

62

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/Country.mmdb.yml).

Tests18pt80

A test script is configured in package.json.

Reproducibility6pt90

Lockfile present (yarn.lock). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.prettierrc.js).

Project health

73

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.

Dependency manifest6pt65

Dependency manifest found (package.json).

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)
  • 24
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • <1h
    Median PR merge time
  • 1
    Open issues
Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/Country.mmdb.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, npm). Dependencies stay current.
  • GeoIP
  • IconSet
  • MitM
  • Mock
  • Module
  • Page
  • RuleSet
  • Script
  • _config.yml
  • .gitignore
    Good: .gitignore present.
  • .prettierrc.js
    Good: Linter or formatter configured (.prettierrc.js).
  • CNAME
  • favicon.ico
  • General.dconf
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: 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.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.