lukasparke/plex-api-spec

0

/ 100

Documentation49
Engineering34
Health58
82MIT1d ago
Grade a repo

Some interest. A stronger README and CI would help.

A Plex Media Server OpenAPI Specification maintained by the community

Documentation

49

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 instructions9pt45

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

→ Add a section showing how to install dependencies.

README12pt48

README is present.

License6pt100

Licensed under MIT.

Engineering

34

Tests18pt0

No tests detected anywhere in the repository.

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

Reproducibility6pt0

No dependency lockfile found (−70 pts).

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

CI/CD14pt40

CI is configured (.github/workflows/sdk_generation.yaml).

Linting and formatting5pt100

Linter or formatter configured (.prettierrc).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

58

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 metadata5pt60

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)
  • 26
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 6h
    Median issue response
  • 2h
    Median PR merge time
  • 12
    Open issues
Repository files9 root entries
  • .github
    Good: CI is configured (.github/workflows/sdk_generation.yaml).
    Good: Issue or PR templates present.
  • .speakeasy
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • description.md
  • LICENSE
    Good: Licensed under MIT.
  • plex-api-spec.yaml
  • 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.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    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.
    Good: README documents how to run the project.