wppconnect-team/wa-version

0

/ 100

Documentation48
Engineering39
Health79
HTML169Apache-2.01d ago
Grade a repo

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

Documentation

48

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

README12pt78

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

39

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

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.

CI/CD14pt72

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

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

79

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 manifest6pt85

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)
  • 60
    Forks
  • 1000
    Releaseslatest 4mo ago

Community

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

Responsiveness

  • 11h
    Median issue response
  • <1h
    Median PR merge time
  • 5
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
  • .husky
  • html
  • src
  • .commitlintrc.json
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • .prettierignore
  • .release-it.yml
  • CHANGELOG.md
  • eslint.config.js
  • LICENSE
    Good: Licensed under Apache-2.0.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • prettier.config.js
  • README.md
    Good: README is present.
    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.
  • tsconfig.json
  • versions.json