vxaboveground/overlord

0

/ 100

Documentation81
Engineering63
Health84
TypeScript137Apache-2.01d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

Overlord

Documentation

81

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.

README12pt90

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

63

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.

Tests18pt80

Test files detected (Overlord-Client/cmd/agent/capture/backstage_inject_windows_test.go).

Reproducibility6pt80

Lockfile present (Overlord-Client/go.sum). Installs are reproducible.

CI/CD14pt85

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

Project health

84

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Dependency manifest6pt100

Dependency manifest found (go.work).

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 1mo ago

Community

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

Responsiveness

  • 5h
    Median issue response
  • 9h
    Median PR merge time
  • 2
    Open issues
Repository files23 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
  • .vscode
  • BackstageCapture
  • BackstageInjection
  • docker
  • Overlord-Client
    Good: Test files detected (Overlord-Client/cmd/agent/capture/backstage_inject_windows_test.go).
    Good: Lockfile present (Overlord-Client/go.sum). Installs are reproducible.
  • Overlord-Desktop
  • Overlord-Server
  • plugins
  • scripts
  • stress
  • .dockerignore
  • .env.example
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • docker-compose.quickstart.yml
  • docker-compose.windows.yml
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • go.work
    Good: Dependency manifest found (go.work).
  • go.work.sum
  • LICENSE
    Good: Licensed under Apache-2.0.
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.