Plan
GitHub在编码前创建结构化的实施计划。通过研究代码、澄清歧义并生成包含自包含上下文和具体任务的Markdown计划文件,确保代理能独立执行,且在用户批准前不实施任何更改。
触发场景
需要编写复杂功能代码前
涉及多文件或数据流变更的重构任务
需要明确实施步骤以指导后续编码的指令
安装
npx skills add mereyabdenbekuly-ctrl/clodex-ide --skill Plan -g -y
SKILL.md
Frontmatter
{
"name": "Plan",
"description": "Create a structured implementation plan before coding",
"user-invocable": true,
"agent-invocable": false
}
You must create a structured implementation plan. Follow these instructions:
Workflow
- Research — read all affected files, trace data flow, understand the full change surface.
- Clarify — if genuinely ambiguous, batch questions into one
askUserQuestionscall. - Write — create a kebab-case
.mdinplans/. - Stop — present a summary and wait for approval. Do NOT implement until the user confirms.
Plan File Spec
- Line 1:
# Plan Title(h1) — used as display name in UI. - Line 2: One-sentence plain-text description — used as summary in UI.
- Body: Freeform markdown. Use whatever sections best explain the change — Problem, Approach, Context, Changes, File Map, Key Details, etc. No fixed structure required; scale detail to complexity. Do not use emojis.
- Self-contained: A fresh agent with no prior context should be able to implement the plan without re-researching the codebase. Include relevant file paths (mount-prefixed, e.g.
w4ba9/src/...), current behavior, key decisions and rationale in prose sections. Omit sections that add no value. - Checkboxes: Use GFM checkboxes (
- [ ]) for tasks. See Checkbox Rules below.
- Self-contained: A fresh agent with no prior context should be able to implement the plan without re-researching the codebase. Include relevant file paths (mount-prefixed, e.g.
Checkbox Rules
Every checkbox = one concrete, completable work item.
- Agent-completable only — every checkbox MUST be doable by you alone with your own tools. Never write tasks that require the user to act (manual testing, running commands in their shell, restarting a dev server, exporting env vars, reviewing, clicking through a UI, obtaining credentials, etc.). If such work is genuinely needed, describe it in a prose
## Follow-ups for the usersection — never as a checkbox. - Short label — the
- [ ]line is a concise, scannable summary (one sentence). It says what to do, not how. - Details below — implementation specifics (file paths, code snippets, sub-steps) go in indented content underneath the checkbox line. Never cram these into the checkbox line itself.
- No alternatives — resolve choices in prose above, then write one task for the chosen approach.
- No optional/decorative items — if conditional, resolve the condition; include as firm task or omit.
- Parent-child consistency — parent is complete only when all children are complete.
Example
# Rename Commands to Skills
Rename all "command" terminology to "skill" across shared types, backend, and UI.
## Context
The codebase currently uses "command" (`CommandDefinition`, `CommandSource`, etc.) but the
user-facing terminology has shifted to "skill". The rename touches 3 files and 6 import sites.
## Tasks
- [ ] Rename `CommandDefinition` type and its source file
Rename `w4ba9/src/shared/commands.ts` → `skills.ts`. Inside the file:
- `CommandSource` → `SkillSource`
- `CommandDefinition` → `SkillDefinition`
- `toCommandDefinitionUI` → `toSkillDefinitionUI`
Update all 6 import sites listed in the Context section.
- [ ] Update Karton state key from `commands` to `skills`
In `w4ba9/src/shared/karton-contracts/ui/index.ts` (line ~629),
change the state key and update the JSDoc comment above it.
- [ ] Verify typecheck passes
Run `pnpm -F clodex typecheck` for both `tsconfig.ui.json` and `tsconfig.backend.json`.
版本历史
- 0f01f5b 当前 2026-07-19 09:03


