trash-guides/guides

0

/ 100

Documentation66
Engineering53
Health100
Markdown3,035MITtoday
Grade a repo

Strong community interest, but tests, CI, or docs need work.

TRaSH-Guides is a comprehensive collection of guides for Radarr, Sonarr, and related media management applications.

Documentation

66

Install and run instructions9pt45

README documents how to install the project.

README12pt55

README is present.

Contributing guide5pt89

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

53

Tests18pt0

No tests detected anywhere in the repository.

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

CI/CD14pt72

CI is configured (.github/workflows/pr-naming-check.yml).

Reproducibility6pt80

Lockfile present (docs/requirements.txt). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (docs/requirements.txt).

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

Community

  • 87% - Good
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 3,035
    Watchers

Responsiveness

  • 2h
    Median issue response
  • <1h
    Median PR merge time
  • 11
    Open issues
Repository files22 root entries
  • .github
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/pr-naming-check.yml).
    Good: Issue or PR templates present.
  • .vscode
  • docs
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (docs/requirements.txt).
  • images
  • includes
    Good: Environment pinned via includes/docker/docker-compose.yml.
  • overrides
  • schemas
  • scripts
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .imgbotconfig
  • .markdownlint.yaml
  • .pre-commit-config.yaml
  • .yamllint.yml
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CONTRIBUTORS.md
  • LICENSE
    Good: Licensed under MIT.
  • metadata.json
  • metadata.schema.json
  • mkdocs.yml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.