smogon/pokemon-showdown

0

/ 100

Documentation71
Engineering72
Health97
TypeScript5,741MIT3d ago
Grade a repo

Good community traction and solid fundamentals. Nearly in the top tier.

Pokémon battle simulator.

Documentation

71

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

README12pt70

README is present.

Contributing guide5pt88

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

72

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

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

Reproducibility6pt70

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

Tests18pt100

Test files detected (.mocharc.json).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

97

Dependency manifest6pt92

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

  • 42 / 254
    Commits (30d / 90d)
  • 3,409
    Forks
  • 6
    Releaseslatest 1y ago

Community

  • 62% - Fair
    Community health
  • 4 bus factor
    authors own >50% of commits
  • 5,741
    Watchers

Responsiveness

  • 8h
    Median issue response
  • <1h
    Median PR merge time
  • 319
    Open issues
Repository files35 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
  • .vscode
  • config
  • data
  • databases
  • lib
  • logs
  • server
  • sim
  • test
  • tools
  • translations
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .mocharc.json
    Good: Test files detected (.mocharc.json).
  • .npmignore
  • .npmrc
  • ARCHITECTURE.md
  • build
  • CODEOWNERS
  • COMMANDLINE.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • eslint-ps-standard.mjs
  • eslint.config.mjs
  • LICENSE
    Good: Licensed under MIT.
  • old-simulator-doc.txt
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • pokemon-showdown
  • Procfile
  • PROTOCOL.md
  • README.md
    Good: README is present.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown 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.
    Good: README documents how to run the project.
  • simulator-doc.txt
  • tsconfig.json