Skip to content

R3ijar/open-growth-loop

Open Growth Loop

Local-first maintainer intelligence for open-source repositories.

CI Repository Audit License: Apache-2.0 Python 3.10+ Release: v0.2.0

Open Growth Loop answers one question for maintainers: what should I improve next?

Point it at any repository and it scores maintainer readiness in one command — no setup, no data files. Feed it local analytics exports and it plans one conservative, evidence-backed action per day. Everything runs on your machine: no accounts, no API keys, and no project data ever leaves it.

Open Growth Loop maintainer workflow

Quickstart

pip install git+https://github.com/R3ijar/open-growth-loop
ogl audit --workspace path/to/your-repo

Thirty seconds later, outbox/audit/latest-audit.md holds a scorecard over 14 hygiene checks — README quality, license, install and quickstart onboarding, docs, examples, community files, changelog, CI, and release-tag cadence:

Check Category Status Detail
README essentials PASS README is present with enough content to evaluate the project.
License essentials PASS A license file is present.
Quickstart onboarding WARN README has no usage section with a copy-pasteable example.
Continuous integration automation WARN No CI configuration was found; contributors cannot see whether tests pass.
Release tags release PASS Latest tag is v1.3.0.

...plus nine more checks, and then the part that matters:

Field Value
Action Add a Quickstart section with one runnable example and its expected output.
Why now README has no usage section with a copy-pasteable example.
Confidence medium

Every audit recommends exactly one next action, ordered by how much each gap hurts a new visitor, with a step checklist and a Codex-ready prompt — so the next focused change is one paste away. Reports stay local; add outbox/ to your .gitignore if you don't want to keep them.

And when the gap is mechanical, you don't even have to write the file:

ogl fix --workspace path/to/your-repo                 # scaffold the recommended action
ogl fix --workspace path/to/your-repo --license mit   # licenses need an explicit choice

ogl fix scaffolds missing community files, changelogs, licenses, issue/PR templates, and an ecosystem-detected starter CI workflow — with TODO markers, never overwriting anything. Checks that need real judgment (README content, docs, quickstart) hand you the Codex prompt instead. A bare repository typically goes from 0% to ~70% with fixes alone; the rest is writing worth doing yourself.

Use It As A GitHub Action

Add one workflow file and the audit runs on every push, straight into the Actions job summary:

name: Repository Audit
on:
  push:
    branches: [main]

jobs:
  audit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: R3ijar/open-growth-loop@main

The action exposes ok and score-percent outputs and an optional strict gate that fails the job when README or LICENSE is missing. Full reference: docs/GITHUB_ACTION.md. This repository runs it on itself.

The Full Loop

The audit covers hygiene; the loop plans from evidence. Drop privacy-safe CSV exports into data/ — Search Console rows, aggregate event counts (date,asset,event,count only), a content inventory, an experiment ledger — and Open Growth Loop turns them into one conservative daily action:

ogl init --workspace .       # create the data files
ogl validate --workspace .   # schema and privacy-safe header checks
ogl plan --workspace .       # one action, fully explained
{
  "action_type": "release_evidence",
  "asset": "/guides/configuration-checklist",
  "confidence": "high",
  "reason": "Staged work should be proven public before creating another asset."
}

Each plan ships with a decision trace (what won, what lost and why, which thresholds applied) and a data freshness report (whether the inputs deserve trust). Completed work and its later outcomes feed back into ranking, so the loop learns locally. Browse real generated reports in the report gallery.

Planner Engine Coverage

Candidates are ranked across the maintainer surfaces that shape OSS adoption, in deliberately conservative priority order:

  1. Release evidence — prove staged docs, examples, or package pages are actually public before starting anything new.
  2. Outcome memory — record what happened to completed work before repeating it.
  3. Funnel dropoff — public pages with enough views but weak install, try, or next-step clicks.
  4. Search opportunities — near-ranking pages and low-CTR queries from Search Console exports.
  5. Planned assets — the next queued guide or page, only when stronger signals are absent.

Weak evidence is labeled insufficient instead of being spun into a win. The goal is less thrash, not a content treadmill.

Commands

Command What it does
ogl audit Zero-config repository readiness scorecard with one recommended action.
ogl fix Scaffold the recommended action when it is mechanical; hand off a Codex prompt when it is not.
ogl init / ogl validate Create and check the local data CSVs.
ogl doctor One-shot readiness report across validation, freshness, privacy, planning, and release review.
ogl demo Generate the complete report set in one run.
ogl freshness Warn when local inputs are too stale to trust.
ogl candidates / ogl plan Rank every considered action; select one with a full decision trace.
ogl prompt / ogl issue-drafts Turn the plan into a Codex-ready prompt or a reviewable issue draft.
ogl complete / ogl outcome Record what was done and what happened, so ranking learns locally.
ogl track-experiment / ogl ship / ogl review-experiments Baseline, ship, and conservatively review changes.
ogl weekly-review / ogl query-backlog / ogl report-index Operating summaries and the report front page.
ogl privacy-scan Check local files for private-data leakage before sharing.

Full walkthroughs, data schemas, thresholds, and column aliases live in the usage guide.

Privacy Boundary

Open Growth Loop is designed around aggregate inputs. The event importer accepts only date,asset,event,count and rejects private-looking columns such as email, user, session, ip, payload, token, or secret. It never uploads analytics or project files, never calls hosted APIs, never publishes changes automatically, and never claims a change worked from tiny samples or missing artifacts.

Documentation

Project Status

Current release: v0.2.0 — an early, active project. The zero-config audit, fix scaffolds, and GitHub Action are ready for any repository today; the CSV-driven loop is ready for small maintainer workflows. Verified by 80 tests, a ruff lint gate, and CI on Python 3.10–3.13.

Contributing

Issues and pull requests are welcome — CONTRIBUTING.md covers setup and expectations, and docs/NEXT_ISSUES.md lists good starting points. Please keep private product data and unverifiable adoption claims out of examples and docs; ogl privacy-scan and the release-brief guardrails exist for exactly that.

License

Apache-2.0

About

Local-first CLI for OSS maintainers to turn Search Console, aggregate events, inventory, and experiment CSVs into one conservative docs, package, or release action.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

6 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages