49 lines
2.4 KiB
Markdown
49 lines
2.4 KiB
Markdown
# CraftKit
|
|
|
|
CraftKit 是一组面向 Codex 插件市场的中性 Skill 工具。项目从通用问题出发独立实现能力，不携带任何公司的品牌、内部框架、业务规则、源码、模板或环境信息。
|
|
|
|
## 文档导航
|
|
|
|
- [协作约定](AGENTS.md)：项目范围、Skill 设计、迁移边界、验证和 Git 规则。
|
|
- [迁移计划](migration/MIGRATION_PLAN.md)：迁移批次、依赖顺序、合并原则和验收门禁。
|
|
- [迁移追踪说明](migration/README.md)：来源指纹和状态维护方式。
|
|
|
|
## 插件组成
|
|
|
|
| 插件 | 用途 | 当前状态 |
|
|
| --- | --- | --- |
|
|
| `dev` | 软件设计、编码、审查与测试 | 已迁移 `component`、`style`、`form` |
|
|
| `doc` | 文档转换、整理与写作 | 已迁移 `format-md`、`docx-to-md`、`md-to-docx`、`xlsx-to-md`、`archive` |
|
|
| `git` | 分支、提交、变更提取与集成 | 已迁移 `commit-msg`、`branch`、`identity`、`export`、`integrate` |
|
|
| `knowledge` | 项目初始化、交接、复盘与经验 | 已迁移 `handoff`、`init`、`trace`、`distill`、`lessons`、`worklog` |
|
|
| `skill` | 项目规范及 Skill 创建、迁移与维护 | 已迁移 `guidance` |
|
|
|
|
## 目录结构
|
|
|
|
```text
|
|
CraftKit/
|
|
├─ .agents/plugins/marketplace.json # 仓库级 Codex 市场清单
|
|
├─ AGENTS.md # Codex 与贡献者协作约定
|
|
├─ migration/ # 迁移计划、来源指纹与状态追踪
|
|
├─ plugins/ # 可独立安装的插件
|
|
│ ├─ dev/
|
|
│ ├─ doc/
|
|
│ ├─ git/
|
|
│ ├─ knowledge/
|
|
│ └─ skill/
|
|
└─ README.md
|
|
```
|
|
|
|
## 开发约束
|
|
|
|
- Skill 必须独立重写，不复制公司插件的正文、脚本、模板、示例或规则库。
|
|
- 专有能力应先抽象为可配置、基于公开标准或用户显式输入的中性平替；不能仅因专有内容较多就整体排除。
|
|
- 发布内容不得出现公司名称、产品名称、内部域名、内部包名、项目名或人员信息。
|
|
- 每个 Skill 文件夹名必须与 `SKILL.md` frontmatter 的 `name` 一致。
|
|
- 新增或修改插件后必须执行 Skill 校验、插件校验和去公司化扫描。
|
|
- 上游变化只用于触发人工复核，不得自动覆盖已迁移内容。
|
|
|
|
## 本地使用
|
|
|
|
这是仓库级 marketplace。安装前先将本仓库注册为本地 marketplace，再按需安装其中的插件。正式发布前还需要补充许可证、公开仓库地址、作者信息、隐私政策及市场素材。
|