🎯 AI-Readiness Report

johnpapa/vscode-peacock · Generated April 28, 2026

📊 Your Repo Today

🥈 On Track · 5 of 12 nailed

TypeScript (99%) · VS Code Extension API · Mocha (87 tests) · npm run build

✅ Nailed It (5)

Asset	Detail
README Contributing	Links to CONTRIBUTING.md with full setup guide
Changelog	CHANGELOG.md — Keep a Changelog format, current
Documentation	`docs/` directory linked from README
dependabot.yml	Configured for npm and GitHub Actions
CI workflow	`build.yml` — build + test + lint on PR

💡 Could Be Better (2)

Asset	Suggestion
Issue templates	Has old-format `.md` templates — consider converting to YAML form format
copilot-instructions.md	No PR review patterns captured — 12 merged PRs had no review comments

Why these matter: YAML form templates give contributors structured fields. PR review mining turns repeated feedback into automated conventions — but needs review comments to mine.

⭕ Missing (5)

Asset	Why it matters
AGENTS.md	AI agents won't know repo structure, build commands, or how to add a color command
Maintenance matrix	Adding a command requires updating package.json, command enum, and docs
copilot-setup-steps.yml	Cloud agent can't build the project without setup steps
PR template	PRs have no structured description, checklist, or test instructions
.vscode/mcp.json	N/A — no database or API dependencies detected

Why these matter: Without AGENTS.md and a maintenance matrix, every AI agent has to rediscover which files need updating when something changes.

🛠️ What I'd Like To Do — proposed changes to close the gaps

Action	Detail
➕ Create	`AGENTS.md` — repo structure, build/test commands, how to add a color command
➕ Create	`copilot-instructions.md` — TypeScript conventions, extension patterns, maintenance matrix
➕ Create	`copilot-setup-steps.yml` — Node 20, npm install, npm run build
➕ Create	`PULL_REQUEST_TEMPLATE.md` — description, changes, test steps, checklist
➕ Create	`bug-report.yml` — structured form with VS Code version, OS, Peacock settings
➕ Create	`feature-request.yml` — description, motivation, alternatives
⏭️ Skip	`.vscode/mcp.json` — N/A, no database or API dependencies
💬 Suggest	Convert old `.md` issue templates to YAML form format

🏆 If You Accept

🏆 AI-Ready · 12 of 12 nailed

🤖 AI Context

🔧 Dev Workflow

📖 Onboarding

🚀 What's Next?

Create the PR now — just say: create a branch and open a PR with these changes
Tweak first — tell me what to change, e.g.: update the AGENTS.md to include more detail about the command registration pattern
Share the report — want a visual version? Say: generate an HTML report I can share
Skip for now — the analysis is done. Come back anytime and say make this repo ai-ready