openclaw/docs

0

/ 100

Documentation52
Engineering72
Health86
JavaScript71MIT1d ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

OpenClaw docs + translation

Documentation

52

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.

README12pt55

README is present.

License6pt100

Licensed under MIT.

Engineering

72

Linting and formatting5pt0

No linter or formatter found.

→ Add ESLint (eslint.config.js) and/or Prettier (.prettierrc), install them as devDependencies, and add a `lint` script to package.json.

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/CD14pt85

CI is configured (.github/workflows/docs-code-ci.yml).

Reproducibility6pt90

Lockfile present (package-lock.json). Installs are reproducible.

Tests18pt100

Test files detected (.agents/skills/autoreview/tests).

Project health

86

Dependency manifest6pt55

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

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

Community

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

Responsiveness

  • —
    Median issue response
  • 8h
    Median PR merge time
  • 4
    Open issues
Repository files18 root entries
  • .agents
    Good: Test files detected (.agents/skills/autoreview/tests).
  • .github
    Good: CI is configured (.github/workflows/docs-code-ci.yml).
    Good: Dependabot covers 2 ecosystems (npm, github-actions). Dependencies stay current.
  • .openclaw-sync
  • docs
  • scripts
  • workers
  • .crabbox.yaml
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • CLAUDE.md
  • CLOUDFLARE.md
  • LICENSE
    Good: Licensed under MIT.
  • Makefile
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    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.
    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.
  • SECURITY.md
    Good: Security policy present.
  • wrangler.toml