engineering-conventions/README.md

# 工程协作约定

一套与具体工具无关的 AI 编码协作约定，适用于任何 AI 编码助手（Claude Code、Codex、Copilot、DeepSeek Harness 等）与人工协作的场景。

内容涵盖：动手前先找现成实现、公共代码与多文件改动先对齐、改实现同轮改文档、最小验证、长时间任务汇报进度、规范的提交信息与代码文风。

## 内容

| 文件 | 说明 |
|---|---|
| `skills/engineering-conventions/SKILL.md` | 约定正文：工作方式、动手前先对齐、执行与验证、上下文成本、Git、代码文风 |
| `index.json` | DeepSeek Harness 市场索引（format 1） |
| `package.json`、`cordis.patch.yml`、`lib/index.js` | DeepSeek Harness bundle 声明与技能提供方接线 |
| `.claude-plugin/plugin.json` | Claude Code 插件清单 |
| `.claude-plugin/marketplace.json` | WorkBuddy 套件市场清单（Claude Code 也识别） |

`SKILL.md` 是纯 Markdown，可以直接阅读，也可以作为任意 AI 助手的指令文件（system prompt、规则文件、技能条目都适用）。

## 在 DeepSeek Harness 中安装

DSH 不自带任何市场源，需要在 Plugins 页开启实验功能 “Custom plugin indexes”，然后在 Discover → Add index source 里填索引地址：

```
https://www.zlhhh.com/ZLH/engineering-conventions/raw/branch/main/index.json
```

索引条目按 git commit 固定版本安装，版本号与 commit 记录在 `index.json` 的 `versions` 中。

## 作为 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」填上面的仓库地址，再从市场安装。

## 在 WorkBuddy 中安装

WorkBuddy 通过 `.claude-plugin/marketplace.json` 把这个仓库识别为套件市场，市场里只有一个套件 `engineering-conventions`。添加市场只是登记来源，不会自动安装，需要再手动点安装。

界面路径：专家·技能·连接器 → 技能 → 技能市场 → 套件 → 套件市场 → 添加市场，市场源填：

```
https://www.zlhhh.com/ZLH/engineering-conventions.git
```

也可以在命令行操作：

```bash
codebuddy plugin marketplace add https://www.zlhhh.com/ZLH/engineering-conventions.git -n engineering-conventions
codebuddy plugin install engineering-conventions@engineering-conventions
```

## 版本

同一份版本号记在四处，改动技能内容后一起递增：

- `package.json` 的 `version`（DSH bundle）
- `.claude-plugin/plugin.json` 的 `version`（Claude Code 插件）
- `.claude-plugin/marketplace.json` 的 `plugins[].version`（WorkBuddy 套件市场）
- `index.json` 里的 `versions` 条目（DSH 市场索引，需同时更新 `commit` 为提交后的完整 SHA 与 `publishTimestamp`）

## 许可

MIT