kimi-dev-workflow 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- kimi_dev_workflow-0.1.0/.gitignore +35 -0
- kimi_dev_workflow-0.1.0/.grepaiignore +97 -0
- kimi_dev_workflow-0.1.0/.kimi/README.md +144 -0
- kimi_dev_workflow-0.1.0/.kimi/memory.md +53 -0
- kimi_dev_workflow-0.1.0/.kimi/prompts/01-search.md +24 -0
- kimi_dev_workflow-0.1.0/.kimi/prompts/02-code.md +33 -0
- kimi_dev_workflow-0.1.0/.kimi/prompts/03-refactor.md +29 -0
- kimi_dev_workflow-0.1.0/.kimi/prompts/04-debug.md +34 -0
- kimi_dev_workflow-0.1.0/.kimi/prompts/05-review.md +31 -0
- kimi_dev_workflow-0.1.0/.kimi/prompts/06-wiki.md +22 -0
- kimi_dev_workflow-0.1.0/.kimi/prompts/07-memory.md +32 -0
- kimi_dev_workflow-0.1.0/AGENTS.md +109 -0
- kimi_dev_workflow-0.1.0/LICENSE +21 -0
- kimi_dev_workflow-0.1.0/PKG-INFO +317 -0
- kimi_dev_workflow-0.1.0/README.md +287 -0
- kimi_dev_workflow-0.1.0/docs/faq.md +107 -0
- kimi_dev_workflow-0.1.0/docs/setup.md +224 -0
- kimi_dev_workflow-0.1.0/dotfiles/.kimi-aliases.zsh +42 -0
- kimi_dev_workflow-0.1.0/install.sh +116 -0
- kimi_dev_workflow-0.1.0/pyproject.toml +55 -0
- kimi_dev_workflow-0.1.0/scripts/kimi-index +231 -0
- kimi_dev_workflow-0.1.0/scripts/kimi-wiki +294 -0
- kimi_dev_workflow-0.1.0/scripts/release.sh +71 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/__init__.py +3 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/cli.py +45 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/commands/__init__.py +1 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/commands/doctor.py +119 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/commands/index.py +84 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/commands/init.py +242 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/commands/memory.py +47 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/commands/wiki.py +75 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/config.py +52 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/detector.py +130 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/renderer.py +107 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/.grepaiignore.template +97 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/AGENTS.md.template +109 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/kimi_dir/README.md +144 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/kimi_dir/memory.md.template +53 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/kimi_dir/prompts/01-search.md +24 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/kimi_dir/prompts/02-code.md +33 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/kimi_dir/prompts/03-refactor.md +29 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/kimi_dir/prompts/04-debug.md +34 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/kimi_dir/prompts/05-review.md +31 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/kimi_dir/prompts/06-wiki.md +22 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/templates/kimi_dir/prompts/07-memory.md +32 -0
- kimi_dev_workflow-0.1.0/src/kimi_dev_workflow/utils.py +43 -0
- kimi_dev_workflow-0.1.0/templates/.grepaiignore.template +97 -0
- kimi_dev_workflow-0.1.0/templates/.kimi/README.md +144 -0
- kimi_dev_workflow-0.1.0/templates/.kimi/memory.md.template +53 -0
- kimi_dev_workflow-0.1.0/templates/.kimi/prompts/01-search.md +24 -0
- kimi_dev_workflow-0.1.0/templates/.kimi/prompts/02-code.md +33 -0
- kimi_dev_workflow-0.1.0/templates/.kimi/prompts/03-refactor.md +29 -0
- kimi_dev_workflow-0.1.0/templates/.kimi/prompts/04-debug.md +34 -0
- kimi_dev_workflow-0.1.0/templates/.kimi/prompts/05-review.md +31 -0
- kimi_dev_workflow-0.1.0/templates/.kimi/prompts/06-wiki.md +22 -0
- kimi_dev_workflow-0.1.0/templates/.kimi/prompts/07-memory.md +32 -0
- kimi_dev_workflow-0.1.0/templates/AGENTS.md.template +109 -0
- kimi_dev_workflow-0.1.0/wiki/01-getting-started.md +7 -0
- kimi_dev_workflow-0.1.0/wiki/02-architecture.md +7 -0
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Git
|
|
2
|
+
node_modules/
|
|
3
|
+
dist/
|
|
4
|
+
build/
|
|
5
|
+
coverage/
|
|
6
|
+
*.log
|
|
7
|
+
.DS_Store
|
|
8
|
+
|
|
9
|
+
# IDE
|
|
10
|
+
.vscode/
|
|
11
|
+
.idea/
|
|
12
|
+
*.swp
|
|
13
|
+
*.swo
|
|
14
|
+
|
|
15
|
+
# 临时文件
|
|
16
|
+
*.tmp
|
|
17
|
+
*.temp
|
|
18
|
+
.grepai/
|
|
19
|
+
|
|
20
|
+
# Python
|
|
21
|
+
__pycache__/
|
|
22
|
+
*.py[cod]
|
|
23
|
+
*$py.class
|
|
24
|
+
*.egg-info/
|
|
25
|
+
*.egg
|
|
26
|
+
.eggs/
|
|
27
|
+
*.whl
|
|
28
|
+
*.tar.gz
|
|
29
|
+
.pytest_cache/
|
|
30
|
+
.mypy_cache/
|
|
31
|
+
.ruff_cache/
|
|
32
|
+
|
|
33
|
+
# 发布产物(由 CI 生成)
|
|
34
|
+
/dist/
|
|
35
|
+
/build/
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# Auto-generated by kimi-dev-workflow
|
|
2
|
+
# 排除不需要索引的文件,加速 embedding 构建
|
|
3
|
+
|
|
4
|
+
# ========== 构建产物 ==========
|
|
5
|
+
node_modules/
|
|
6
|
+
dist/
|
|
7
|
+
build/
|
|
8
|
+
coverage/
|
|
9
|
+
|
|
10
|
+
# ========== 版本控制 ==========
|
|
11
|
+
.git/
|
|
12
|
+
|
|
13
|
+
# ========== IDE/编辑器 ==========
|
|
14
|
+
.vscode/
|
|
15
|
+
.idea/
|
|
16
|
+
*.swp
|
|
17
|
+
*.swo
|
|
18
|
+
|
|
19
|
+
# ========== 日志 ==========
|
|
20
|
+
*.log
|
|
21
|
+
npm-debug.log*
|
|
22
|
+
|
|
23
|
+
# ========== 测试文件 ==========
|
|
24
|
+
*.test.ts
|
|
25
|
+
*.test.tsx
|
|
26
|
+
*.test.js
|
|
27
|
+
*.test.jsx
|
|
28
|
+
*.spec.ts
|
|
29
|
+
*.spec.tsx
|
|
30
|
+
*.spec.js
|
|
31
|
+
*.spec.jsx
|
|
32
|
+
__tests__/
|
|
33
|
+
*.mock.ts
|
|
34
|
+
*.mock.tsx
|
|
35
|
+
*.mock.js
|
|
36
|
+
*.mock.jsx
|
|
37
|
+
|
|
38
|
+
# ========== 样式文件(语义价值低)==========
|
|
39
|
+
*.css
|
|
40
|
+
*.scss
|
|
41
|
+
*.less
|
|
42
|
+
*.sass
|
|
43
|
+
|
|
44
|
+
# ========== 配置文件 ==========
|
|
45
|
+
*.config.js
|
|
46
|
+
*.config.ts
|
|
47
|
+
vite.config.*
|
|
48
|
+
tsconfig*.json
|
|
49
|
+
.eslintrc*
|
|
50
|
+
.prettierrc*
|
|
51
|
+
postcss.config.*
|
|
52
|
+
tailwind.config.*
|
|
53
|
+
|
|
54
|
+
# ========== 文档(语义价值低)==========
|
|
55
|
+
*.md
|
|
56
|
+
README*
|
|
57
|
+
CHANGELOG*
|
|
58
|
+
LICENSE*
|
|
59
|
+
|
|
60
|
+
# ========== Wiki 知识库(语义价值高)==========
|
|
61
|
+
!wiki/**/*.md
|
|
62
|
+
!.kimi/wiki/**/*.md
|
|
63
|
+
|
|
64
|
+
# ========== Agent 记忆(语义价值高)==========
|
|
65
|
+
!.kimi/memory.md
|
|
66
|
+
|
|
67
|
+
# ========== 静态资源 ==========
|
|
68
|
+
public/
|
|
69
|
+
*.png
|
|
70
|
+
*.jpg
|
|
71
|
+
*.jpeg
|
|
72
|
+
*.gif
|
|
73
|
+
*.svg
|
|
74
|
+
*.ico
|
|
75
|
+
*.woff
|
|
76
|
+
*.woff2
|
|
77
|
+
*.ttf
|
|
78
|
+
*.eot
|
|
79
|
+
|
|
80
|
+
# ========== 自动生成的类型文件 ==========
|
|
81
|
+
*.d.ts
|
|
82
|
+
|
|
83
|
+
# ========== 项目特定(按需修改)==========
|
|
84
|
+
# 自动生成的图标
|
|
85
|
+
# src/components/icons/
|
|
86
|
+
|
|
87
|
+
# shadcn/ui 等标准组件库
|
|
88
|
+
# src/components/ui/
|
|
89
|
+
|
|
90
|
+
# 富文本编辑器(第三方复杂逻辑)
|
|
91
|
+
# src/editor/
|
|
92
|
+
|
|
93
|
+
# 遗留代码
|
|
94
|
+
# src/legacy/
|
|
95
|
+
|
|
96
|
+
# mock 数据
|
|
97
|
+
# src/mocks/
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
# 🚀 Kimi Dev Workflow — 项目工作流指南
|
|
2
|
+
|
|
3
|
+
## 常用快捷命令
|
|
4
|
+
|
|
5
|
+
在 Kimi CLI 中(输入 `kimi` 后):
|
|
6
|
+
|
|
7
|
+
| 命令 | 作用 |
|
|
8
|
+
|------|------|
|
|
9
|
+
| `/plan` | 让 AI 先制定计划再执行 |
|
|
10
|
+
| `/compact` | 压缩对话历史,释放上下文窗口 |
|
|
11
|
+
| `/mcp` | 查看已加载的 MCP 工具 |
|
|
12
|
+
| `/help` | 查看所有命令 |
|
|
13
|
+
|
|
14
|
+
## 文件投喂策略
|
|
15
|
+
|
|
16
|
+
### ✅ 精准投喂(推荐)
|
|
17
|
+
只给 AI 必要的文件,节省 token,提高精度:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
> 帮我看一下 @src/pages/login.tsx 的登录逻辑
|
|
21
|
+
> 搜索所有处理 JWT token 刷新的代码
|
|
22
|
+
> 参照 @src/pages/list.tsx 新增一个详情页
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### ❌ 避免全量投喂
|
|
26
|
+
```
|
|
27
|
+
> 帮我改一下 @. ← 不要这样,浪费 token,效果差
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Prompt 模板使用
|
|
31
|
+
|
|
32
|
+
项目目录下有 `.kimi/prompts/` 存放常用 prompt 模板:
|
|
33
|
+
|
|
34
|
+
| 模板 | 场景 |
|
|
35
|
+
|------|------|
|
|
36
|
+
| `01-search.md` | 代码搜索与分析 |
|
|
37
|
+
| `02-code.md` | 新代码编写 |
|
|
38
|
+
| `03-refactor.md` | 代码重构 |
|
|
39
|
+
| `04-debug.md` | Bug 调试 |
|
|
40
|
+
| `05-review.md` | 代码审查 |
|
|
41
|
+
| `06-wiki.md` | 基于 Wiki 知识开发 |
|
|
42
|
+
| `07-memory.md` | 基于记忆的智能开发 |
|
|
43
|
+
|
|
44
|
+
**使用方式:** 打开文件,复制对应模板,替换 `{}` 中的变量。
|
|
45
|
+
|
|
46
|
+
## 索引管理
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# 启动索引(后台运行)
|
|
50
|
+
kimi-index start
|
|
51
|
+
|
|
52
|
+
# 查看状态
|
|
53
|
+
grepai status
|
|
54
|
+
|
|
55
|
+
# 手动搜索
|
|
56
|
+
grepai search "关键词"
|
|
57
|
+
|
|
58
|
+
# 停止索引
|
|
59
|
+
kimi-index stop
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Wiki 知识库
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
# 初始化 Wiki(本地或从远程克隆)
|
|
66
|
+
kimi-wiki init
|
|
67
|
+
kimi-wiki init https://github.com/user/repo.wiki.git
|
|
68
|
+
|
|
69
|
+
# 同步远程 Wiki 更新
|
|
70
|
+
kimi-wiki sync
|
|
71
|
+
|
|
72
|
+
# 列出所有 Wiki 页面
|
|
73
|
+
kimi-wiki list
|
|
74
|
+
|
|
75
|
+
# 语义搜索 Wiki
|
|
76
|
+
kimi-wiki search "订单状态机"
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## 开发流程示例
|
|
80
|
+
|
|
81
|
+
### 新增一个页面
|
|
82
|
+
|
|
83
|
+
```bash
|
|
84
|
+
# 1. 进入项目
|
|
85
|
+
cd your-project
|
|
86
|
+
|
|
87
|
+
# 2. 启动 Kimi CLI
|
|
88
|
+
kimi
|
|
89
|
+
|
|
90
|
+
# 3. 先让 AI 理解现有模式(自动搜索 memory.md 和 wiki)
|
|
91
|
+
> 帮我看一下订单模块的路由和页面结构
|
|
92
|
+
|
|
93
|
+
# 4. 精准投喂参考文件
|
|
94
|
+
> 参照 @src/pages/orders/list.tsx 和 @src/router/orders.ts
|
|
95
|
+
> 我要新增一个批量操作的页面
|
|
96
|
+
|
|
97
|
+
# 5. AI 会搜索相关代码,给出完整方案
|
|
98
|
+
# 6. 确认后执行(--yolo 模式自动批准)
|
|
99
|
+
# 7. AI 自动将学到的模式记录到 .kimi/memory.md
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### 排查 bug
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
kimi
|
|
106
|
+
|
|
107
|
+
# 1. 描述现象
|
|
108
|
+
> 订单列表页筛选后数据不更新,帮我排查
|
|
109
|
+
|
|
110
|
+
# 2. AI 自动搜索相关代码和踩坑记录
|
|
111
|
+
# 3. 定位问题,给出修复方案
|
|
112
|
+
# 4. AI 自动记录踩坑经验到 .kimi/memory.md
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### 利用记忆提升效率
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
kimi
|
|
119
|
+
|
|
120
|
+
# 第一次:明确偏好
|
|
121
|
+
> 帮我新增用户模块,我偏好用 Zustand 做状态管理
|
|
122
|
+
# AI 完成并记录偏好到 .kimi/memory.md
|
|
123
|
+
|
|
124
|
+
# 第二次:直接复用偏好
|
|
125
|
+
> 帮我新增订单模块
|
|
126
|
+
# AI 自动搜索 memory.md,发现用户偏好 Zustand
|
|
127
|
+
# 直接给出符合用户习惯的方案,无需再次确认
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## 性能优化
|
|
131
|
+
|
|
132
|
+
### 上下文窗口管理
|
|
133
|
+
- 长会话 (>20 轮) 后用 `/compact` 压缩
|
|
134
|
+
- 精准 @ 文件,不要全量投喂
|
|
135
|
+
- 复杂任务拆分成多轮对话
|
|
136
|
+
|
|
137
|
+
### 索引加速
|
|
138
|
+
- 使用 `all-minilm:l6-v2`(22MB,比默认快 3-5 倍)
|
|
139
|
+
- 配置 `.grepaiignore` 排除无关文件
|
|
140
|
+
- 只索引 `src/` 核心代码
|
|
141
|
+
|
|
142
|
+
---
|
|
143
|
+
|
|
144
|
+
*项目工作流指南 v1.0*
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# 🤖 Agent 记忆库
|
|
2
|
+
|
|
3
|
+
> 本文件由 Agent 自动维护,记录项目开发过程中的学习、决策和偏好。
|
|
4
|
+
> 每次完成重要任务后,Agent 会在对应章节追加新的记忆条目。
|
|
5
|
+
> 开始新任务前,Agent 应优先搜索本文件获取历史上下文。
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 👤 用户偏好
|
|
10
|
+
|
|
11
|
+
### 编码风格
|
|
12
|
+
- (示例)偏好函数式组件,禁止 class 组件
|
|
13
|
+
- (示例)Hooks 命名统一用 `useXxx`,工具函数用 `camelCase`
|
|
14
|
+
|
|
15
|
+
### 架构倾向
|
|
16
|
+
-
|
|
17
|
+
|
|
18
|
+
### 技术偏好
|
|
19
|
+
-
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## 📋 决策记录
|
|
24
|
+
|
|
25
|
+
| 时间 | 场景 | 决策 | 原因 | 验证结果 |
|
|
26
|
+
|------|------|------|------|----------|
|
|
27
|
+
| | | | | |
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## 🐛 踩坑记录
|
|
32
|
+
|
|
33
|
+
| 时间 | 问题 | 根因 | 解决方案 | 相关文件 |
|
|
34
|
+
|------|------|------|----------|----------|
|
|
35
|
+
| | | | | |
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 🔍 发现的模式
|
|
40
|
+
|
|
41
|
+
| 时间 | 模式描述 | 适用场景 | 示例/出处 |
|
|
42
|
+
|------|----------|----------|-----------|
|
|
43
|
+
| | | | |
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 📌 快速参考
|
|
48
|
+
|
|
49
|
+
### 新增 XX 的标准流程
|
|
50
|
+
1.
|
|
51
|
+
|
|
52
|
+
### 常见问题的快速解法
|
|
53
|
+
-
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# 🔍 代码搜索与分析
|
|
2
|
+
|
|
3
|
+
## 场景:理解某个业务逻辑
|
|
4
|
+
|
|
5
|
+
我想理解 {业务模块} 的代码逻辑,请帮我:
|
|
6
|
+
1. 找到相关的核心文件(组件、hooks、API)
|
|
7
|
+
2. 梳理数据流和状态管理
|
|
8
|
+
3. 说明关键的业务规则
|
|
9
|
+
|
|
10
|
+
## 场景:查找某个函数/组件的定义和使用
|
|
11
|
+
|
|
12
|
+
请帮我找到 {函数名/组件名} 的定义位置,以及所有调用它的地方。
|
|
13
|
+
|
|
14
|
+
## 场景:理解跨模块的数据流转
|
|
15
|
+
|
|
16
|
+
{模块A} 和 {模块B} 之间是怎么传递数据的?帮我梳理完整的数据流。
|
|
17
|
+
|
|
18
|
+
## 场景:找 bug 的根因
|
|
19
|
+
|
|
20
|
+
{问题描述},帮我分析可能的根因,重点检查:
|
|
21
|
+
1. 状态更新逻辑
|
|
22
|
+
2. 异步请求处理
|
|
23
|
+
3. 条件渲染/边界情况
|
|
24
|
+
4. 类型定义是否匹配实际数据
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# ✨ 代码编写
|
|
2
|
+
|
|
3
|
+
## 场景:新页面开发
|
|
4
|
+
|
|
5
|
+
我要在 {模块路径} 下新增一个 {页面功能} 页面,请帮我:
|
|
6
|
+
1. 参照同模块的现有页面,确定路由、文件结构
|
|
7
|
+
2. 使用现有的数据获取模式
|
|
8
|
+
3. 复用已有的业务组件
|
|
9
|
+
4. 遵循已有的表单校验和错误处理模式
|
|
10
|
+
|
|
11
|
+
## 场景:新增组件
|
|
12
|
+
|
|
13
|
+
我需要创建一个 {组件功能} 组件,要求:
|
|
14
|
+
1. 放在 {components/xxx} 下
|
|
15
|
+
2. Props 接口定义完整
|
|
16
|
+
3. 支持受控和非受控两种模式(如适用)
|
|
17
|
+
4. 参照 {参照组件路径} 的风格和接口设计
|
|
18
|
+
|
|
19
|
+
## 场景:新增 API 接口
|
|
20
|
+
|
|
21
|
+
我需要调用 {后端接口},请帮我:
|
|
22
|
+
1. 在正确位置新增 API 函数
|
|
23
|
+
2. 定义请求/响应类型
|
|
24
|
+
3. 使用统一的错误处理
|
|
25
|
+
4. 如有需要,新增对应的状态管理 action
|
|
26
|
+
|
|
27
|
+
## 场景:新增路由
|
|
28
|
+
|
|
29
|
+
我要新增一个 {路由路径} 的页面,请帮我:
|
|
30
|
+
1. 在对应模块的路由配置中添加
|
|
31
|
+
2. 创建页面组件文件
|
|
32
|
+
3. 更新导航菜单配置(如需要)
|
|
33
|
+
4. 添加路由参数类型定义(如有动态参数)
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# 🔧 代码重构
|
|
2
|
+
|
|
3
|
+
## 场景:提取公共逻辑到 hooks
|
|
4
|
+
|
|
5
|
+
这段代码 {代码片段} 在多个地方重复,请帮我:
|
|
6
|
+
1. 提取为自定义 hook,放在合适位置
|
|
7
|
+
2. 保持现有行为不变
|
|
8
|
+
3. 更新所有使用处
|
|
9
|
+
|
|
10
|
+
## 场景:组件拆分
|
|
11
|
+
|
|
12
|
+
这个组件 {组件路径} 太大了,请帮我拆分为:
|
|
13
|
+
1. 容器组件(数据获取、状态管理)
|
|
14
|
+
2. 展示子组件(纯 UI)
|
|
15
|
+
3. 保持 props 接口清晰
|
|
16
|
+
|
|
17
|
+
## 场景:状态管理优化
|
|
18
|
+
|
|
19
|
+
这个模块的状态管理有点混乱,请帮我:
|
|
20
|
+
1. 分析当前状态分布
|
|
21
|
+
2. 区分全局/局部状态
|
|
22
|
+
3. 提出最佳分配方案
|
|
23
|
+
|
|
24
|
+
## 场景:类型安全提升
|
|
25
|
+
|
|
26
|
+
这段代码有很多 any / 类型断言,请帮我:
|
|
27
|
+
1. 补齐类型定义
|
|
28
|
+
2. 移除不必要的类型断言
|
|
29
|
+
3. 处理可能的 null/undefined
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# 🐛 Bug 修复
|
|
2
|
+
|
|
3
|
+
## 场景:功能异常
|
|
4
|
+
|
|
5
|
+
{功能描述} 不工作了,表现为:{错误现象}
|
|
6
|
+
请帮我:
|
|
7
|
+
1. 定位相关代码
|
|
8
|
+
2. 分析可能的根因
|
|
9
|
+
3. 提供修复方案
|
|
10
|
+
4. 检查是否有其他受影响的地方
|
|
11
|
+
|
|
12
|
+
## 场景:性能问题
|
|
13
|
+
|
|
14
|
+
{页面/组件} 加载/响应很慢,请帮我:
|
|
15
|
+
1. 分析可能的性能瓶颈
|
|
16
|
+
2. 检查是否有不必要的重渲染
|
|
17
|
+
3. 检查 API 请求是否可优化
|
|
18
|
+
4. 提供优化方案
|
|
19
|
+
|
|
20
|
+
## 场景:类型错误
|
|
21
|
+
|
|
22
|
+
TypeScript 报错:{错误信息}
|
|
23
|
+
请帮我:
|
|
24
|
+
1. 定位报错的代码位置
|
|
25
|
+
2. 分析类型不匹配的原因
|
|
26
|
+
3. 提供正确的类型定义
|
|
27
|
+
|
|
28
|
+
## 场景:测试失败
|
|
29
|
+
|
|
30
|
+
{测试文件} 测试失败了,错误是:{错误信息}
|
|
31
|
+
请帮我:
|
|
32
|
+
1. 分析失败原因
|
|
33
|
+
2. 修复测试或修复代码
|
|
34
|
+
3. 检查是否有遗漏的测试场景
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# 📋 代码审查
|
|
2
|
+
|
|
3
|
+
## 场景:PR 审查
|
|
4
|
+
|
|
5
|
+
请审查这段代码变更:
|
|
6
|
+
{diff 或文件路径}
|
|
7
|
+
|
|
8
|
+
关注:
|
|
9
|
+
1. 业务逻辑正确性
|
|
10
|
+
2. 边界情况处理
|
|
11
|
+
3. 类型安全
|
|
12
|
+
4. 是否遵循项目规范(AGENTS.md)
|
|
13
|
+
5. 是否有更好的实现方式
|
|
14
|
+
|
|
15
|
+
## 场景:接口设计审查
|
|
16
|
+
|
|
17
|
+
我要新增一个 API 接口 / 组件接口,请帮我审查:
|
|
18
|
+
{接口定义}
|
|
19
|
+
|
|
20
|
+
关注:
|
|
21
|
+
1. 命名是否清晰
|
|
22
|
+
2. 参数是否完整
|
|
23
|
+
3. 错误处理是否充分
|
|
24
|
+
4. 是否和现有接口风格一致
|
|
25
|
+
|
|
26
|
+
## 场景:依赖升级影响
|
|
27
|
+
|
|
28
|
+
我要升级 {依赖名} 从 {旧版本} 到 {新版本},请帮我:
|
|
29
|
+
1. 检查 breaking changes
|
|
30
|
+
2. 评估对本项目的影响范围
|
|
31
|
+
3. 提供迁移方案
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# 📖 基于 Wiki 知识开发
|
|
2
|
+
|
|
3
|
+
## 场景:理解业务背景后修改代码
|
|
4
|
+
|
|
5
|
+
我要修改 {模块/功能},相关背景知识请搜索 wiki:
|
|
6
|
+
1. 搜索 wiki 中关于 {业务概念} 的说明
|
|
7
|
+
2. 结合代码理解当前实现
|
|
8
|
+
3. 确保修改符合业务规则和架构约定
|
|
9
|
+
|
|
10
|
+
## 场景:新功能开发(需符合现有约定)
|
|
11
|
+
|
|
12
|
+
我要新增 {功能},请帮我:
|
|
13
|
+
1. 搜索 wiki 中的相关架构/约定文档
|
|
14
|
+
2. 参照现有代码模式
|
|
15
|
+
3. 确保遵循项目规范和业务规则
|
|
16
|
+
|
|
17
|
+
## 场景:排查涉及业务逻辑的问题
|
|
18
|
+
|
|
19
|
+
{问题描述},请帮我:
|
|
20
|
+
1. 搜索 wiki 了解相关业务规则和预期行为
|
|
21
|
+
2. 对比代码实现与业务规则是否一致
|
|
22
|
+
3. 定位并修复问题
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# 🧠 基于记忆的智能开发
|
|
2
|
+
|
|
3
|
+
## 场景:开始新任务前获取上下文
|
|
4
|
+
|
|
5
|
+
我要处理 {任务描述},请帮我:
|
|
6
|
+
1. 搜索 `.kimi/memory.md` 中的相关历史记录
|
|
7
|
+
2. 了解用户的偏好和过往决策
|
|
8
|
+
3. 基于记忆给出最佳方案
|
|
9
|
+
|
|
10
|
+
## 场景:完成任务后更新记忆
|
|
11
|
+
|
|
12
|
+
我刚完成了 {任务},关键信息如下:
|
|
13
|
+
- 决策/变更:{描述}
|
|
14
|
+
- 原因:{描述}
|
|
15
|
+
- 踩到的坑:{描述}
|
|
16
|
+
|
|
17
|
+
请帮我更新 `.kimi/memory.md`,追加到对应章节。
|
|
18
|
+
|
|
19
|
+
## 场景:排查重复出现的问题
|
|
20
|
+
|
|
21
|
+
{问题描述},请帮我:
|
|
22
|
+
1. 搜索 `.kimi/memory.md` 的踩坑记录
|
|
23
|
+
2. 搜索 wiki 中的相关知识
|
|
24
|
+
3. 给出根因分析和修复方案
|
|
25
|
+
|
|
26
|
+
## 场景:总结当前会话的学习
|
|
27
|
+
|
|
28
|
+
请总结本次对话中的关键学习,并更新 `.kimi/memory.md`:
|
|
29
|
+
- 做出的重要决策
|
|
30
|
+
- 发现的模式或约定
|
|
31
|
+
- 用户的偏好表达
|
|
32
|
+
- 踩到的坑及解决方式
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# kimi-dev-workflow — 项目架构与开发规范
|
|
2
|
+
|
|
3
|
+
## 📦 技术栈
|
|
4
|
+
|
|
5
|
+
| 层 | 技术 |
|
|
6
|
+
|---|---|
|
|
7
|
+
| 框架 | Python + hatchling |
|
|
8
|
+
| 构建 | hatchling |
|
|
9
|
+
| 状态 | — |
|
|
10
|
+
| 路由 | — |
|
|
11
|
+
| 样式 | — |
|
|
12
|
+
| HTTP | requests / httpx |
|
|
13
|
+
| 校验 | pydantic |
|
|
14
|
+
| 表单 | — |
|
|
15
|
+
|
|
16
|
+
## 🗂️ 目录结构速查
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
src/
|
|
20
|
+
├── pages/ ← 页面组件(路由对应)
|
|
21
|
+
├── components/ ← 复用组件
|
|
22
|
+
│ ├── ui/ ← 基础 UI 组件(Button/Dialog/Table 等)
|
|
23
|
+
│ └── business/ ← 业务组件
|
|
24
|
+
├── hooks/ ← 自定义 Hooks
|
|
25
|
+
├── stores/ ← 状态管理(Zustand/Redux)
|
|
26
|
+
├── api/ ← API 层 / 接口定义
|
|
27
|
+
├── utils/ ← 工具函数
|
|
28
|
+
├── router/ ← 路由配置
|
|
29
|
+
└── types/ ← 全局类型定义
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## 🎯 核心开发模式
|
|
33
|
+
|
|
34
|
+
### 路由模式
|
|
35
|
+
{描述你的路由组织方式,如:每个模块独立 router.tsx,在根路由汇总}
|
|
36
|
+
|
|
37
|
+
### 状态管理模式
|
|
38
|
+
{描述状态分层策略,如:全局用 Zustand,局部用 React Context}
|
|
39
|
+
|
|
40
|
+
### API 请求模式
|
|
41
|
+
{描述数据获取封装,如:统一 useQueryAction / TanStack Query}
|
|
42
|
+
|
|
43
|
+
### 表单模式
|
|
44
|
+
{描述表单处理,如:react-hook-form + zod 校验}
|
|
45
|
+
|
|
46
|
+
## 📝 编码规范
|
|
47
|
+
|
|
48
|
+
1. **组件**:函数式组件 + Hooks
|
|
49
|
+
2. **状态**:
|
|
50
|
+
- 全局共享 → —
|
|
51
|
+
- 模块内 → —
|
|
52
|
+
- 禁止直接修改 store state,必须通过 action
|
|
53
|
+
3. **API**:统一走封装层,错误处理用统一 自定义 Exception
|
|
54
|
+
4. **类型**:接口定义优先用 `interface`,表单 schema 用 pydantic
|
|
55
|
+
|
|
56
|
+
## 🔍 常见问题定位
|
|
57
|
+
|
|
58
|
+
| 问题 | 定位路径 |
|
|
59
|
+
|---|---|
|
|
60
|
+
| 路由跳转失败 | src/ |
|
|
61
|
+
| 全局状态不更新 | — |
|
|
62
|
+
| API 请求报错 | src/ |
|
|
63
|
+
| 认证问题 | — |
|
|
64
|
+
| 布局异常 | — |
|
|
65
|
+
|
|
66
|
+
## 📚 Wiki 知识库
|
|
67
|
+
|
|
68
|
+
项目维护了一份本地 Wiki,包含业务规则、架构决策、开发约定等知识:
|
|
69
|
+
|
|
70
|
+
- 位置:`wiki/` 目录
|
|
71
|
+
- 格式:Markdown
|
|
72
|
+
- 索引状态:已通过 grepai 建立语义索引
|
|
73
|
+
|
|
74
|
+
**当你需要理解以下内容时,请优先搜索 Wiki:**
|
|
75
|
+
- 业务规则、领域概念
|
|
76
|
+
- 架构决策、模块边界
|
|
77
|
+
- API 约定、数据格式
|
|
78
|
+
- 部署配置、环境差异
|
|
79
|
+
|
|
80
|
+
搜索方式:使用 grepai MCP 工具进行语义搜索,或让用户执行 `kimi-wiki search "关键词"`
|
|
81
|
+
|
|
82
|
+
## 🧠 Agent 记忆与学习
|
|
83
|
+
|
|
84
|
+
项目维护了一份记忆文件 `.kimi/memory.md`,记录开发过程中的关键学习:
|
|
85
|
+
|
|
86
|
+
### 何时更新记忆
|
|
87
|
+
每次完成涉及以下内容的任务后,请在 `.kimi/memory.md` 中追加记录:
|
|
88
|
+
- 代码架构或设计模式的变更
|
|
89
|
+
- 重要的技术决策及原因
|
|
90
|
+
- 踩过的坑及解决方案
|
|
91
|
+
- 用户的明确偏好(编码风格、命名习惯、技术倾向等)
|
|
92
|
+
- 发现的重复模式或最佳实践
|
|
93
|
+
|
|
94
|
+
### 何时读取记忆
|
|
95
|
+
开始新任务前,请先搜索 `.kimi/memory.md` 获取相关上下文:
|
|
96
|
+
- 涉及类似模块时,查看是否有历史决策
|
|
97
|
+
- 遇到报错时,查看踩坑记录
|
|
98
|
+
- 不确定用户偏好时,查看用户偏好部分
|
|
99
|
+
- 需要遵循既有模式时,查看发现的模式
|
|
100
|
+
|
|
101
|
+
### 更新格式要求
|
|
102
|
+
- 追加到对应章节,不要覆盖已有内容
|
|
103
|
+
- 时间格式:YYYY-MM-DD
|
|
104
|
+
- 保持简洁,一条记忆不超过 3 行
|
|
105
|
+
|
|
106
|
+
Global Rules:
|
|
107
|
+
- 所有 AI 输出使用简体中文
|
|
108
|
+
- 代码修改后保留原有注释和格式化风格
|
|
109
|
+
- 涉及路由变更时同步更新 —
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|