mcpField
U
update-project

update-project

github.com/tartinerlabs开发8378 次安装6 天前更新
代码仓库

关于 update-project

用于让项目文档与近期代码变更及提交保持一致的开发技能。它会对照代码库核实文档，只更新有依据的内容。

主要功能

  1. 01检查近期提交和差异
  2. 02检查 Agent 指令文件和 README
  3. 03扫描 Agent、技能和规则组件
  4. 04根据项目现状更新文档
  5. 05验证文档中的命令和配置

适用场景

  1. 01重大代码变更后更新文档
  2. 02发布前核对项目文档
  3. 03查找过时的 Agent 指令和组件文档

安装

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

$npx skills add https://github.com/tartinerlabs/skills --skill update-project

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

附带文件rules/agent-docs.mdrules/components.md

详细介绍

让项目文档与近期代码更改和 git 提交保持同步。

在重大代码更改后、发布前，或文档可能过时的任何时候运行。

只更新项目实际发生变化的内容。写入前先对照代码树核实每项声明，无法核实的部分保持原样。

AGENTS.md 是 Agent 指令文件——供 Claude Code、Codex 和其他宿主读取的跨 Agent 标准。将 CLAUDE.md 视为旧版文件：如果已存在则维护，但不要新建。组件目录遵循相同的区分方式——.claude/ 用于 Claude Code，.agents/skills/ 用于 Codex 和其他使用跨 Agent 技能路径的宿主。不要臆造 .agents/agents 或 .agents/rules。

规则概览

规则影响文件
Agent 文档（AGENTS.md / CLAUDE.md / README.md）高rules/agent-docs.md
组件（Agent、技能、规则）中rules/components.md

工作流

第 1 步：检测
  • 运行 git log --oneline -20 和 git diff，识别近期更改
  • 检查哪些 Agent 指令文件（AGENTS.md、CLAUDE.md）存在，以及 README.md 是否存在（如缺失则创建）
  • 扫描 .claude/agents/*.md、.claude/skills/*/SKILL.md、.claude/rules/*.md 和 .agents/skills/*/SKILL.md
  • 将文档中的指令与项目实际状态进行对比，找出过时部分
  • 标记新增工具、已移除依赖、变更路径或重命名命令
第 2 步：更新

阅读相关规则文件并应用更新：

  • 对 AGENTS.md / CLAUDE.md / README.md 的更改，参阅 rules/agent-docs.md
  • 对 .claude/ 下的 Agent、技能和规则，以及 .agents/skills/ 下的内容，参阅 rules/components.md
第 3 步：验证
  • 运行文档中提到的项目命令，确认其有效
  • 检查指令是否与当前项目配置一致
  • 确保 Agent 指令文件（AGENTS.md）、README.md、Agent、技能和规则相互补充且内容不重复
  • 如果 AGENTS.md 和 CLAUDE.md 均存在，应根据 rules/agent-docs.md 提议整合到 AGENTS.md，而不是保留内容不一致的副本

评论

支持 Markdown