Skip to content

Latest commit

 

History

History
98 lines (83 loc) · 4.73 KB

File metadata and controls

98 lines (83 loc) · 4.73 KB

OSS Maintainer Signal

oss-signal is a maintainer-readiness CLI and GitHub Action for open-source projects that need repeatable repository health checks, CI evidence, inventory reports, SARIF output, issue-ready cleanup notes, PR-sized maintainer plans, adoption packs, a transparent rule catalog, and no-fail workflow trials.

Quick Start

Add a report-only workflow to the current checkout:

npx oss-signal --init

Run against a public GitHub repository without cloning it:

npx oss-signal SalmonPlays/oss-signal

Run as a GitHub Action:

- uses: SalmonPlays/oss-signal@1bb4418e14be225b5f5b628986ea464241caf7f1 # v0.10.0
  id: oss-signal
  with:
    path: "."
    format: markdown
    output: oss-signal-report.md

What It Checks

  • README, license, contributing, security, support, and changelog files
  • CI, tests, CodeQL, Dependabot, issue templates, and PR templates
  • GitHub repository URL audits without cloning
  • Inventory reports across multiple repositories
  • Markdown, summary, JSON, env, SARIF, issue-ready, maintainer-plan, and workflow output formats
  • Rule catalog output with scoring weights for pre-review transparency

Reviewer Evidence

Public Links