chore: 清理 CraftKit 迁移资料
This commit is contained in:
@@ -1,30 +1,23 @@
|
||||
# CraftKit
|
||||
|
||||
CraftKit 是一组面向 Codex 插件市场的中性 Skill 工具。项目从通用问题出发独立实现能力,不携带任何公司的品牌、内部框架、业务规则、源码、模板或环境信息。
|
||||
|
||||
## 文档导航
|
||||
|
||||
- [协作约定](AGENTS.md):项目范围、Skill 设计、迁移边界、验证和 Git 规则。
|
||||
- [迁移计划](migration/MIGRATION_PLAN.md):迁移批次、依赖顺序、合并原则和验收门禁。
|
||||
- [迁移追踪说明](migration/README.md):来源指纹和状态维护方式。
|
||||
CraftKit 是面向 Codex 的通用插件工具集,覆盖软件开发、文档处理、Git 交付、项目知识维护和 Skill 管理。每个插件均可独立安装,能力描述保持简洁、中性,并以当前 Codex 能力和公开标准为基础维护。
|
||||
|
||||
## 插件组成
|
||||
|
||||
| 插件 | 用途 | 当前状态 |
|
||||
| --- | --- | --- |
|
||||
| `dev` | 软件设计、实现、审查、测试、升级与估算 | 已迁移 22 个 Skill,覆盖完整通用开发流程 |
|
||||
| `doc` | 文档转换、整理与写作 | 已迁移 8 个 Skill,新增报告、消息与需求整理 |
|
||||
| `git` | 分支、提交、变更提取、集成与发布 | 已迁移 6 个 Skill,发布操作按阶段分别授权 |
|
||||
| `knowledge` | 项目初始化、交接、复盘与经验 | 已迁移 `handoff`、`init`、`trace`、`distill`、`lessons`、`worklog` |
|
||||
| `skill` | 项目规范及 Skill 创建、迁移与维护 | 已迁移 `guidance`、`guidance-edit` |
|
||||
| 插件 | 用途 |
|
||||
| --- | --- |
|
||||
| `dev` | 软件需求分析、设计、实现、审查、测试、升级与估算 |
|
||||
| `doc` | 文档转换、整理、归档与写作 |
|
||||
| `git` | 分支、提交、变更提取、集成与发布准备 |
|
||||
| `knowledge` | 项目初始化、任务交接、问题复盘与经验维护 |
|
||||
| `skill` | 项目规范检索、维护与 Skill 辅助工具 |
|
||||
|
||||
## 目录结构
|
||||
|
||||
```text
|
||||
CraftKit/
|
||||
├─ .agents/plugins/marketplace.json # 仓库级 Codex 市场清单
|
||||
├─ AGENTS.md # Codex 与贡献者协作约定
|
||||
├─ migration/ # 迁移计划、来源指纹与状态追踪
|
||||
├─ .agents/plugins/marketplace.json # 仓库级 Codex 插件市场清单
|
||||
├─ AGENTS.md # 项目协作与维护约定
|
||||
├─ plugins/ # 可独立安装的插件
|
||||
│ ├─ dev/
|
||||
│ ├─ doc/
|
||||
@@ -34,15 +27,16 @@ CraftKit/
|
||||
└─ README.md
|
||||
```
|
||||
|
||||
## 开发约束
|
||||
## 设计原则
|
||||
|
||||
- Skill 必须独立重写,不复制公司插件的正文、脚本、模板、示例或规则库。
|
||||
- 专有能力应先抽象为可配置、基于公开标准或用户显式输入的中性平替;不能仅因专有内容较多就整体排除。
|
||||
- 发布内容不得出现公司名称、产品名称、内部域名、内部包名、项目名或人员信息。
|
||||
- 每个 Skill 文件夹名必须与 `SKILL.md` frontmatter 的 `name` 一致。
|
||||
- 新增或修改插件后必须执行 Skill 校验、插件校验和去公司化扫描。
|
||||
- 上游变化只用于触发人工复核,不得自动覆盖已迁移内容。
|
||||
- 每个 Skill 聚焦一个清晰能力,名称与触发描述准确,避免宽泛兜底或重复功能。
|
||||
- 优先读取当前项目的代码、配置、规范和用户输入,不把特定组织、产品或环境假设写入通用能力。
|
||||
- 公共技术规则基于适用版本的官方资料维护;项目专属规则保存在项目自己的 `.craftkit/standards/` 中。
|
||||
- 涉及写文件、Git 状态、外部系统或发布的操作必须明确边界,并按风险取得用户授权。
|
||||
- 静态检查、脚本测试和真实场景验证分别记录,不用其中一种替代另一种。
|
||||
|
||||
## 本地使用
|
||||
|
||||
这是仓库级 marketplace。安装前先将本仓库注册为本地 marketplace,再按需安装其中的插件。正式发布前还需要补充许可证、公开仓库地址、作者信息、隐私政策及市场素材。
|
||||
本仓库提供仓库级 marketplace。将仓库注册为本地 marketplace 后,可按需安装 `dev`、`doc`、`git`、`knowledge` 或 `skill` 插件。
|
||||
|
||||
正式公开发布前,还需补充许可证、公开仓库地址、作者信息、隐私政策和市场素材。
|
||||
|
||||
Reference in New Issue
Block a user