通用工程协作约定打包为插件

This commit is contained in:
ZLH committed 2026-10-28 11:36:22 +08:00
commit 4402c4c423
5 files changed
+118

No files matched your search

+10
View File
@@ -0,0 +1,10 @@
{
"name": "engineering-conventions",
"description": "通用工程协作约定:动手前先找现成实现、公共代码改动先对齐、改实现同轮改文档、最小验证、长任务报进度、规范提交信息。",
"version": "1.0.0",
"author": {
"name": "左林豪"
},
"homepage": "https://www.zlhhh.com/ZLH/engineering-conventions",
"keywords": ["engineering", "conventions", "workflow", "code-review", "git"]
}
+6
View File
@@ -0,0 +1,6 @@
.DS_Store
Thumbs.db
*.bak
node_modules/
.vscode/
.claude/
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2026 左林豪
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+30
View File
@@ -0,0 +1,30 @@
# engineering-conventions
通用工程协作约定技能,打包为 Claude Code 插件,可独立作为技能市场安装。
## 安装
在 Claude Code 里添加本仓库为插件市场,再安装插件:
```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 提交、代码文风 |
技能在修改代码、做多文件改动、接入框架或跨系统集成、准备提交与验证时自动生效。
## 版本
插件版本在 `.claude-plugin/plugin.json` 的 `version` 字段,改动技能内容后手动递增,再在客户端更新插件。
## 许可
MIT
+51
View File
@@ -0,0 +1,51 @@
---
name: engineering-conventions
description: 通用工程协作约定——动手前先找现成实现、多文件或公共代码改动先对齐、改实现同轮改文档、最小验证、长任务报进度、规范提交信息。适用于修改代码、做多文件改动、接入框架或跨系统集成、准备提交与验证时。
---
# 工程协作约定
## 工作方式
- 不编造:数字、结论、不确定的事实先确认,不臆测。
- 框架接入或跨系统集成:先判断风险;只对最不确定、失败代价最高的环节用最小改动做一次针对性验证,其余路径明确的直接实现;验证通过再写完整版本,能分阶段就先交最小可用版。
- 未明确倾向时按完善方案推进;若受性能、工期或成本约束,先说明代价并给出「完整版/折中版」对照,确认后再降级。
- 等待构建、重启或服务就绪时不使用固定 sleep,改为轮询健康检查或日志。
- 同一轮改动一次改完再构建(含界面文案与文档),只重启一次。
- 预计超过一两分钟的后台任务,开始时说明预计耗时与卡住的环节,过程中主动汇报一次进度。
## 动手前先对齐
- 先找再做:先确认项目中是否已有实现;有类似实现时优先复用、抽取共用或加参数覆盖差异,不写第二个平行实现。确需新写时说明差异点。
- 以下情况先说明打算怎么改并等待确认:多种做法都说得通、要动公共/共享代码、要新增抽象或组件、要改多个文件。单点、路径明确的小改直接做。
- 需求含糊时先复述理解或提问,不自行补全。
- 已被否决的做法不要自行恢复;先给对照数据,确认后再加。
- 改实现与改文档同轮完成:需求或实现偏离参考文档时,同轮更新文档或标注偏差,不留文档与代码不一致的版本。对外文档不擅自修改,先提出确认。
- 内容或数据 id 改名时,同轮更新引用它的代码常量、测试断言、生成器与文档;除明确要求兼容旧档外不留别名。
- 文档同步时同时检索旧标识、旧路径与旧命名,不只改本次涉及的段落。
## 执行与验证
- 大范围探查、互不依赖且不改同一批文件的切片可并行交给子代理;连续编辑、提交、汇总在主对话完成。
- 子代理汇报只说三件事:改了哪些文件、测了什么、未修风险;不要把完整 diff 和长报告倒回主对话。
- 验证使用能证明改动的最小命令,不为跑通编译整包工程。
- 渲染相关改动验证到 build + 单测 + 一张截图即可;无法截图就直接说明,不反复调整。
## 上下文成本
- 常驻上下文只放每次都必须知道的内容;其余放独立文件,用时再查。
- 读文件先定位再定点读;判断需要的内容读全,不确定相关性时宁可多读。
- 同一文件的多个小改合并为一次编辑;同类排查一次搜全。
- 长清单、长方案、长报告落成文件,对话只留结论与路径。
- 不用的插件、技能、MCP 及时关闭。
## Git
- 提交前先构建与测试,全部通过再提交。
- 提交信息按本次变更的最小功能项组织:标题一行说清做了什么;有多项时标题下空一行,用短横线分条,每条单独一行,写清功能点及其影响或原因。
- 单点小改只写标题;提交默认包含工作区全部改动,本地配置与临时产物除外。标题使用中文,不加 emoji。
- 自动生成物(截图、导出数据)默认加入 .gitignore。
## 代码文风
- 注释、日志、文档使用简体中文,不使用 emoji。