moonrend/zerocat

0

/ 100

Documentation43
Engineering63
Health89
JavaScript364AGPL-3.03d ago
Grade a repo

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

ZeroCat 零猫社区 | ZeroCat Community

Documentation

43

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 instructions9pt10

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

→ Add a section showing how to install dependencies.

README12pt58

README is present.

License6pt100

Licensed under AGPL-3.0.

Engineering

63

Tests18pt35

Test files detected (packages/auth-core/auth-core.test.mjs).

CI/CD14pt57

CI is configured (.github/workflows/claude-code-review.yml).

Reproducibility6pt92

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (apps/blog/eslint.config.mjs).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

89

Dependency manifest6pt65

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files23 root entries
  • .github
    Good: CI is configured (.github/workflows/claude-code-review.yml).
    Good: Dependabot configured for unknown.
    Good: Issue or PR templates present.
  • apps
    Good: Linter or formatter configured (apps/blog/eslint.config.mjs).
  • docker
  • packages
    Good: Test files detected (packages/auth-core/auth-core.test.mjs).
  • public
  • scripts
  • .dockerignore
  • .env.example
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .vercelignore
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • EXTENSION_API_DOCS.md
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • process.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.
    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.
  • SECURITY.md
    Good: Security policy present.
  • turbo.json