diff --git a/README.md b/README.md index fa1d6bb..9e77e15 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,31 @@ -# engineering-conventions +# 工程协作约定 -通用工程协作约定技能,打包为 Claude Code 插件,可独立作为技能市场安装。 +一套与具体工具无关的 AI 编码协作约定,适用于任何 AI 编码助手(Claude Code、Codex、Copilot 等)与人工协作的场景。 -## 安装 +内容涵盖:动手前先找现成实现、公共代码与多文件改动先对齐、改实现同轮改文档、最小验证、长时间任务汇报进度、规范的提交信息与代码文风。 -在 Claude Code 里添加本仓库为插件市场,再安装插件: +## 内容 + +| 文件 | 说明 | +|---|---| +| `skills/engineering-conventions/SKILL.md` | 约定正文:工作方式、动手前先对齐、执行与验证、上下文成本、Git、代码文风 | + +`SKILL.md` 是纯 Markdown,可以直接阅读,也可以作为任意 AI 助手的指令文件(system prompt、规则文件、技能条目都适用)。 + +## 作为 Claude Code 插件安装 + +本仓库同时符合 Claude Code 插件格式(`.claude-plugin/plugin.json` + `skills/`),需要时可直接装成插件: ```bash claude plugin marketplace add https://www.zlhhh.com/ZLH/engineering-conventions.git claude plugin install engineering-conventions@engineering-conventions ``` -桌面应用可在「添加插件 → Git URL」填上面这个仓库地址,然后从市场安装。 - -## 内容 - -| 技能 | 说明 | -|---|---| -| `engineering-conventions` | 工作方式、动手前先对齐、执行与验证、上下文成本、Git 提交、代码文风 | - -技能在修改代码、做多文件改动、接入框架或跨系统集成、准备提交与验证时自动生效。 +桌面应用可在「添加插件 → Git URL」填上面的仓库地址,再从市场安装。 ## 版本 -插件版本在 `.claude-plugin/plugin.json` 的 `version` 字段,改动技能内容后手动递增,再在客户端更新插件。 +插件版本在 `.claude-plugin/plugin.json` 的 `version` 字段,改动技能内容后手动递增。 ## 许可