feat: add basic instruction for coding agents

[chilingling]

English | 简体中文

PR 增加基础的 AGENTS.md

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)
• Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• Documentation
  • Added instruction documentation for development workflows, repository structure guidelines, and agent guidance across the monorepo and package scopes.

[coderabbitai]

Walkthrough

Four new documentation files are added to establish coding agent instructions across the monorepo. A root-level AGENTS.md provides canonical guidance for the entire codebase, while CLAUDE.md serves as an entry point. Package-level equivalents are added to packages/vue-generator/ for package-specific workflows.

Changes

Cohort / File(s)	Summary
Root-level Agent Instructions AGENTS.md, CLAUDE.md	Root-level documentation establishing canonical coding agent instructions for the monorepo, including repo structure, working model, verification matrix, approval boundaries, and gotchas. CLAUDE.md references AGENTS.md.
Package-level Agent Instructions packages/vue-generator/AGENTS.md, packages/vue-generator/CLAUDE.md	Package-scoped instruction documents for the vue-generator, detailing SFC generation pipeline, hook execution order, fixture/snapshot workflow, and package-specific guardrails. CLAUDE.md references AGENTS.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A guide for agents, clear and bright,
Instructions scattered left and right,
From root to branch, the rules align,
No more confusion—everything's fine! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: add basic instruction for coding agents' directly and clearly describes the main change: adding instruction documents (AGENTS.md and CLAUDE.md files) for coding agents across the monorepo.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@packages/vue-generator/AGENTS.md`:
- Around line 61-68: The docs for genSetupSFC.js currently list only
addState/addImport/addMethods/addStatement/setScriptConfig but omit several
exported helpers; update packages/vue-generator/AGENTS.md to document the full
API from packages/vue-generator/src/generator/vue/sfc/genSetupSFC.js by adding
the getter helpers (e.g., getState, getMethods, getImports, getStatements), the
style/CSS helpers (e.g., addStyle, addCss, addScopedStyle, setStyleConfig or
similarly named style-related functions found in that file), and brief
descriptions of each function and their parameters so the README accurately
reflects the module's public surface.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 88d42241-7c74-4950-a0f8-de4f907cd60e

📥 Commits

Reviewing files that changed from the base of the PR and between e35908b and 541d9d0.

📒 Files selected for processing (4)

• AGENTS.md
• CLAUDE.md
• packages/vue-generator/AGENTS.md
• packages/vue-generator/CLAUDE.md