43
/ 100
Some interest. A stronger README and CI would help.
A Plex Media Server OpenAPI Specification maintained by the community
A low grade is a to-do list, not a judgment of your code
Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to C (76).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add automated tests. They prove the code works and give contributors confidence to make changes.
- 2CI/CD14pt
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add `pull_request:` to the workflow `on:` triggers.
- 4CI/CD14pt
Add a lint step to catch style issues automatically.
Working through the fixes? Let every push regrade itself.
The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
49
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.
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
README is present.
Licensed under MIT.
Engineering
34
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
No dependency lockfile found (−70 pts).
→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
CI is configured (.github/workflows/sdk_generation.yaml).
Linter or formatter configured (.prettierrc).
Issue or PR templates present.
Project health
58
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 has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 346 / 1608Commits (30d / 90d)
- 26Forks
- 0Releases
Community
- 42% - WeakCommunity health
- 1 bus factorlowauthor own >50% of commits
- 82Watchers
Responsiveness
- 6hMedian issue response
- 2hMedian PR merge time
- 12Open issues
Repository files9 root entries
- .githubGood: CI is configured (.github/workflows/sdk_generation.yaml).Good: Issue or PR templates present.
- .speakeasy
- .gitignoreGood: .gitignore present.
- .prettierignore
- .prettierrcGood: Linter or formatter configured (.prettierrc).
- description.md
- LICENSEGood: Licensed under MIT.
- plex-api-spec.yaml
- README.mdGood: 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.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/lukasparke/plex-api-spec)