Skip to content

[Feature]: readme-writer package — draft a compliant README from the repo's own state #82

Description

@trsdn

Problem or use case

Many repositories in the account have a thin or generic README, failing B02 (purpose, audience, status, setup, key links) or, for public repos, P05 (install, configuration, examples, compatibility, security, support status). Writing one by hand is mechanical enough — read the manifest, the scripts, the entry points — that an agent should draft it, not just flag that it's missing.

Desired outcome

A local, credential-free packages/readme-writer package, in the same shape as apple-hig-review, performance-review, and doc-staleness-reviewer: an agent that reads the repository's actual state (Package.swift/package.json/manifest, scripts, entry points, existing docs) and drafts or updates a README meeting B02/P05, for a human to review before committing. It never commits on its own — same separation repo-assessor keeps between finding and recording.

Alternatives and impact

Alternative: keep relying on templates/AGENTS.md-style copy-paste starting points and the fleet-rollout worker's own judgement each time. That works but re-derives the same draft logic per repository instead of once, versioned. Affects every repository the fleet-rollout procedure brings to the standard, which is most of the account.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions