diff --git a/.craftkit/.gitignore b/.craftkit/.gitignore new file mode 100644 index 0000000..5a8d09c --- /dev/null +++ b/.craftkit/.gitignore @@ -0,0 +1,3 @@ +# Local CraftKit data +/local/ +/cache/ diff --git a/.craftkit/README.md b/.craftkit/README.md new file mode 100644 index 0000000..4e2df44 --- /dev/null +++ b/.craftkit/README.md @@ -0,0 +1,13 @@ +# CraftKit 项目资料 + +本目录保存当前项目可供 Agent 使用的配置、规范、知识和交接内容。 + +- `project.json`:项目类型、技术栈、代码边界、依赖标识和命令。 +- `agents/`:项目对 Agent 的补充指令。 +- `standards/`:项目自身的开发、测试、文档与 Git 规范。 +- `knowledge/`:经过验证的技术决策和可复用经验。 +- `handoff/`:用户明确选择共享的任务交接。 +- `local/`:当前工作副本的本地上下文,不进入 Git。 +- `cache/`:可重新生成的缓存,不进入 Git。 + +共享资料不得包含凭据、个人机器绝对路径或无必要的业务数据。 diff --git a/.craftkit/agents/index.md b/.craftkit/agents/index.md new file mode 100644 index 0000000..cb97e04 --- /dev/null +++ b/.craftkit/agents/index.md @@ -0,0 +1,3 @@ +# Agent 补充说明索引 + +当前没有项目专属 Agent 补充说明。新增说明时记录适用目录、触发条件和文件路径。 diff --git a/.craftkit/knowledge/index.md b/.craftkit/knowledge/index.md new file mode 100644 index 0000000..73e76f7 --- /dev/null +++ b/.craftkit/knowledge/index.md @@ -0,0 +1,7 @@ +# 项目知识索引 + +当前没有已验证的项目知识。只收录有证据、适用范围明确且能够复用的技术决策与经验。 + +- 问题经验按需建立在 `pitfalls/`,不预建空分类。 +- 重要技术决策按需建立在 `decisions/`。 +- 其他长期知识应优先并入已有主题,避免同义平行文档。 diff --git a/.craftkit/project.json b/.craftkit/project.json new file mode 100644 index 0000000..7960752 --- /dev/null +++ b/.craftkit/project.json @@ -0,0 +1,60 @@ +{ + "schemaVersion": 1, + "initialization": { + "mode": "existing", + "references": [] + }, + "project": { + "name": "CraftKit", + "description": "面向 Codex 插件市场的通用插件工具集,提供可独立安装和维护的 Skill。", + "type": "codex-plugin-collection" + }, + "technology": { + "languages": [ + "Markdown", + "JSON", + "YAML", + "Python" + ], + "frameworks": [], + "buildTools": [], + "databases": [] + }, + "code": { + "sourceRoots": [ + "plugins" + ], + "packageRoots": [], + "modules": [ + "plugins/dev", + "plugins/doc", + "plugins/git", + "plugins/knowledge", + "plugins/skill" + ] + }, + "dependencies": { + "internal": [], + "public": [] + }, + "frontend": { + "framework": "", + "componentLibraries": [], + "componentRoots": [], + "documentation": [] + }, + "commands": { + "build": [], + "test": [], + "check": [] + }, + "documents": { + "archiveRoot": "docs/archive", + "archiveRules": [] + }, + "guidance": { + "agentIndex": ".craftkit/agents/index.md", + "standardsIndex": ".craftkit/standards/index.md", + "knowledgeIndex": ".craftkit/knowledge/index.md" + } +} diff --git a/.craftkit/standards/index.md b/.craftkit/standards/index.md new file mode 100644 index 0000000..d5a981c --- /dev/null +++ b/.craftkit/standards/index.md @@ -0,0 +1,3 @@ +# 项目规范索引 + +当前没有项目专属规范。新增规范时记录主题、适用范围、规则文件和优先级;未覆盖主题可由 `guidance` 查询中性公共基线。 diff --git a/AGENTS.md b/AGENTS.md index 24bdc0d..a3be1ae 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -6,6 +6,13 @@ CraftKit 面向 Codex 插件市场,提供简洁、中性、可独立安装和维护的 Skill。每项能力都应具备清晰边界,并能够独立理解与验证。 +## 项目资料 + +- 结构化项目配置:`.craftkit/project.json` +- Agent 补充说明:`.craftkit/agents/index.md` +- 项目规范索引:`.craftkit/standards/index.md` +- 项目知识索引:`.craftkit/knowledge/index.md` + ## 沟通与改动 - 所有回答、文档和代码注释使用中文;公开 API、标准名称和代码标识可以保留英文。