感谢你愿意为 Deepseek Harness Plugin Dev Skill 做贡献!本仓库是文档型项目,欢迎各类改进。
- 修正错误:发现官方文档或本项目引用有误、链接失效、示例代码不工作,请提交 PR。
- 同步官方更新:官方文档更新后,
References/每篇末尾都有"官方文档链接",请对照更新并修订对应精炼内容,同时在CHANGELOG.md记录。 - 新增参考:若某主题(如新的子系统、新扩展点)值得补充,请遵循下面的内容约定新增或扩展文档。
- 改善技能可用性:
SKILL.md的任何改进——更清晰的模板、更准的铁律、更实用的自查表——都非常欢迎。
- 精简提炼,不照搬:
References/是对官方文档的高信号浓缩,不要整段复制官方原文;保留指向官方的 URL。 - 面向 Agent 与人类:文档应同时可被 Agent 按步骤执行、可被人类快速阅读。
- 示例代码必须可运行:
SKILL.md与参考文档中的代码模板需能通过类型检查与端到端运行(见下文"开发与验证")。 - 中文为主,保留英文术语:与官方中文文档保持一致;术语首次出现可附英文。
- 文件命名:
References/使用NN-主题.md(两位数字序号 + kebab-case),并在00-INDEX.md登记。
- Fork 本仓库并克隆到本地。
- 创建特性分支:
git checkout -b fix/xxx或docs/xxx。 - 提交变更,提交信息遵循 Conventional Commits(如
docs: 同步官方文档更新、fix: 修正工具模板)。 - 推送分支并创建 Pull Request,描述改动内容与验证方式。
本仓库为纯文档项目,无构建步骤。但涉及 SKILL.md 或参考文档中的代码模板变更时,请验证:
# 1. 类型检查(需要本机有 DSH 相关包或 tsconfig 指向)
tsc --strict -p /tmp/dsh-plugin-check/tsconfig.json # 或等价方式
# 2. 端到端运行(用真实 Cordis loader)
node <dsh-install>/node_modules/@deepseek-ai/cordis/bin.js验证通过后,在 PR 描述中说明验证结果。
- 友善、专业;评审意见针对代码与内容,不针对个人。
- 尊重原作者的提炼意图:改动应有明确理由,避免无谓的风格翻新。