CommunitySchreiben & Editierengithub.com

tjboudreaux/ready-agent-1

Ready Agent 1 — is your codebase ready for the agents? Score agent-readiness (deterministic, cited, Level 1-5) and clear the gates.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add tjboudreaux/ready-agent-1

Ask in your favorite AI

Open a new chat with this agent skill pre-loaded.

Dokumentation

Agent Readiness Fix

Raise a repo's readiness by applying only safe changes. The engine plans and writes config scaffolds; you handle git and author any prose. Three buckets, three different safety levels.

Steps

  1. Ensure a report exists. If .agents/readiness/latest.json is missing, run the ra1-report skill first.

  2. Dry-run the plan to see what would change:

    python3 "$(dirname "$0")/scripts/readiness/cli.py" fix --project <repo-path>
    

    It prints three buckets: Auto-apply (safe config scaffolds), Propose (drafts for review), GitHub settings (manual).

  3. Create a local branch first (never work on the default branch):

    git -C <repo-path> checkout -b readiness/fixes
    
  4. Apply the safe scaffolds (idempotent; refuses on a dirty worktree; never overwrites non-empty files):

    python3 "$(dirname "$0")/scripts/readiness/cli.py" fix --project <repo-path> --apply
    
  5. Author the "Propose" items yourself — README sections, a tailored AGENTS.md, runbooks, a first test. Write these as drafts for the user to review; do not invent facts about the codebase. templates/AGENTS.md is a starting skeleton — fill it from what the repo actually does.

  6. Show the diff and commit locally. Summarize changes, then:

    git -C <repo-path> add -A && git -C <repo-path> commit -m "chore: raise agent readiness"
    

    End the commit message with the required Co-Authored-By trailer.

  7. Re-run ra1-report to show the level delta.

Contract (do not violate)

  • Never push and never open a PR without explicit user confirmation. Build and commit locally first.
  • Auto-apply config scaffolds only. README/AGENTS.md/tests/runbooks are proposed drafts the user reviews — auto-writing prose risks "documenting fiction."
  • Never bundle GitHub setting changes (branch protection, secret scanning, labels) with code commits. Present them as a checklist of gh commands for the user to run and confirm.
  • Respect a dirty worktree: do not --force over uncommitted work without asking.

Verwandte Skills