pokeapi/api-data

0

/ 100

Shell182BSD-3-Clause1d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

Static JSON data from the API, plus a JSON Schema

Documentation

71

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.

README12pt73

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under BSD-3-Clause.

Engineering

18

Tests18pt0

No tests detected anywhere in the repository.

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

Linting and formatting5pt0

No linter or formatter config found.

Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

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.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

CI/CD14pt57

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

Project health

68

Dependency manifest6pt0

No dependency manifest detected at root.

Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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)
  • 51
    Forks
  • 2
    Releaseslatest 2y ago

Community

  • Community health
  • authors own >50% of commits
  • 182
    Watchers

Responsiveness

  • 1d 4h
    Median issue response
  • 3d 1h
    Median PR merge time
  • 10
    Open issues
Repository files8 root entries
  • .circleci
  • .github
    Good: CI is configured (.github/workflows/test.yml).
  • data
  • scripts
  • updater
    Good: Environment pinned via updater/Dockerfile.
  • .gitignore
    Good: .gitignore present.
  • LICENSE.txt
    Good: Licensed under BSD-3-Clause.
  • 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.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.