mcpField
T
todo-create

todo-create

github.com/everyinc开发25.8k241 次安装今天更新
代码仓库

关于 todo-create

todo-create 是一项技能,用 Markdown 文件和 YAML 元数据维护可跨会话保留的工作项。它规定了命名、结构和生命周期流程,适用于记录代码审查反馈、技术债务及计划工作。

主要功能

  1. 01使用含 YAML frontmatter 的 Markdown 待办
  2. 02区分规范目录与旧目录
  3. 03按顺序编号并标注优先级
  4. 04创建、分流和完成流程
  5. 05跟踪依赖项与阻塞项

适用场景

  1. 01记录待后续处理的代码审查反馈
  2. 02跨会话跟踪技术债务
  3. 03规划存在依赖的工程任务

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/everyinc/compound-engineering-plugin --skill todo-create

安装后在 Claude Code 中输入/todo-create确认已加载。

附带文件assets/todo-template.md

详细介绍

基于文件的待办事项跟踪

概述

.context/compound-engineering/todos/ 目录是一个基于文件的跟踪系统,用于管理代码审查反馈、技术债务、功能请求和工作项。每个待办事项都是一个带有 YAML frontmatter 的 Markdown 文件。

旧版支持: 读取时务必同时检查 .context/compound-engineering/todos/(规范路径)和 todos/(旧版路径)。新待办事项只写入规范路径。此目录具有跨多个会话的生命周期——不要将其作为临时文件清理。

目录路径

用途路径
规范路径(写入此处).context/compound-engineering/todos/
旧版路径(只读)todos/

文件命名约定

{issue_id}-{status}-{priority}-{description}.md
  • issue_id:顺序编号(001、002、……),绝不重复使用
  • status:pending(待处理)| ready(就绪)| complete(已完成)
  • priority:p1(关键)| p2(重要)| p3(锦上添花)
  • description:kebab-case 格式的简短描述

示例: 002-ready-p1-fix-n-plus-1.md

文件结构

每个待办事项都包含 YAML frontmatter 和结构化章节。创建新待办事项时,请使用下方提供的待办事项模板。

---
status: ready
priority: p1
issue_id: "002"
tags: [rails, performance]
dependencies: ["001"]     # Issue IDs this is blocked by
---

必需章节: 问题陈述、调查结果、拟议方案、建议采取的行动(分诊时填写)、验收标准、工作日志。

可选章节: 技术细节、资源、备注。

工作流

工具选择: 查找和读取待办事项文件时,优先使用原生文件搜索/glob 和内容搜索工具,而不是 shell 命令。仅在没有原生等效工具时才使用 shell(mv、mkdir -p)。

创建新待办事项
  1. mkdir -p .context/compound-engineering/todos/
  2. 在两个路径中搜索 [0-9]*-*.md,找到最大的数字前缀,将其加 1,并补零至 3 位。
  3. 使用下方提供的待办事项模板,将文件以 {NEXT_ID}-pending-{priority}-{description}.md 的形式写入规范路径。
  4. 填写问题陈述、调查结果、拟议方案、验收标准以及初始工作日志条目。
  5. 设置状态:pending(需要分诊)或 ready(已预先批准)。

以下情况应创建待办事项: 工作需要超过约 15 分钟、存在依赖项、需要规划或需要确定优先级。如果可以立即处理,则直接着手: 修复简单、明显且独立的问题。

分诊待处理事项
  1. 在两个路径中 glob *-pending-*.md。
  2. 查看每个待办事项的问题陈述、调查结果和拟议方案。
  3. 批准:将文件名和 frontmatter 中的 pending 重命名为 ready,并填写建议采取的行动。
  4. 延后:保持 pending 状态。

加载 todo-triage 技能以使用交互式审批工作流。

管理依赖项
dependencies: ["002", "005"]  # Blocked by these issues
dependencies: []               # No blockers

要检查阻塞项:在两个路径中搜索 {dep_id}-complete-*.md。没有匹配项表示阻塞项尚未完成。

完成待办事项
  1. 验证所有验收标准。
  2. 在工作日志中记录最后一个会话。
  3. 将文件名和 frontmatter 中的 ready 重命名为 complete。
  4. 检查是否有工作项已解除阻塞:搜索包含 dependencies:.*"{issue_id}" 的文件。

与工作流的集成

触发条件流程
代码审查/ce:review -> 调查结果 -> /todo-triage -> 待办事项
自主审查/ce:review mode:autofix -> 剩余待办事项 -> /todo-resolve
代码 TODO/todo-resolve -> 修复 + 复杂待办事项
规划头脑风暴 -> 创建待办事项 -> 开展工作 -> 完成

关键区别

此技能管理以 Markdown 文件形式持久保存、可跨会话延续的工作项。如需临时跟踪会话内的步骤,请改用平台任务工具(Claude Code 中的 TaskCreate/TaskUpdate,Codex 中的 update_plan)。


待办事项模板

@./assets/todo-template.md

评论

支持 Markdown