zeturn/watercolor

0

/ 100

Documentation93
Engineering84
Health97
JavaScript11ISC3d ago
Grade a repo

Well engineered for its size. A portfolio piece worth showing off.

A modern minimalist cross-framework component library supporting Vue 3 and React 18+.

Documentation

93

Contributing guide5pt72

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under ISC.

Engineering

84

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.

Reproducibility6pt70

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

Tests18pt100

Test files detected (packages/react/tests).

CI/CD14pt100

CI is configured (.github/workflows/ci.yml).

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.cjs).

Project health

97

Dependency manifest6pt90

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files29 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • doc
  • docs
  • note
  • packages
    Good: Test files detected (packages/react/tests).
  • public
  • scripts
  • .eslintignore
  • .eslintrc.cjs
    Good: Linter or formatter configured (.eslintrc.cjs).
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • .npmrc.github
  • .prettierrc
  • CHANGELOG.md
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • LICENSE
    Good: Licensed under ISC.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • QUICK_RELEASE.md
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • release.sh
  • theme.config.json
  • tsconfig.base.json
  • tsconfig.json
  • vite.config.js.backup
  • vite.react.config.js.backup
  • vite.vue.config.js.backup
  • vitest.config.js.backup
  • vitest.workspace.ts