rewrite all docs in English
This commit is contained in:
@@ -1,46 +1,46 @@
|
||||
# fix-skills
|
||||
|
||||
当 skill 或脚本未达到预期效果,或脚本报错时使用。
|
||||
Used when a skill or its scripts fail to produce expected results, or throw errors.
|
||||
|
||||
## 原则
|
||||
## Principle
|
||||
|
||||
**不要轻易使用 workaround。** 先定位根因,再决定修复方式。
|
||||
**Do not resort to workarounds lightly.** Identify the root cause first, then fix properly.
|
||||
|
||||
## 流程
|
||||
## Process
|
||||
|
||||
### 1. 收集信息
|
||||
### 1. Gather Information
|
||||
|
||||
- 记录触发场景:怎么调用的,期望什么结果,实际什么结果
|
||||
- 记录错误信息:完整输出(含 stack trace 或脚本调试输出)
|
||||
- 确认环境:模型版本、节点、skill 版本(git log 有帮助)
|
||||
- Record the triggering scenario: how it was called, expected result, actual result
|
||||
- Record the error output in full (stack traces, debug output)
|
||||
- Confirm the environment: model version, node, skill version (git log helps)
|
||||
|
||||
### 2. 分析根因
|
||||
### 2. Analyze Root Cause
|
||||
|
||||
按以下顺序排查:
|
||||
Investigate in this order:
|
||||
|
||||
1. **输入/参数是否正确** — 传给脚本或工具的参数是否符合预期?
|
||||
2. **依赖是否满足** — 所需 secret、token、配置文件是否存在?
|
||||
3. **脚本逻辑是否有 bug** — 读源码,必要时加 `set -x` 调试
|
||||
4. **skill 设计是否有缺陷** — 逻辑本身是否覆盖了这个场景?
|
||||
1. **Are inputs/parameters correct?** — Do they match what the script or tool expects?
|
||||
2. **Are dependencies satisfied?** — Are required secrets, tokens, config files present?
|
||||
3. **Is there a bug in the script logic?** — Read the source, add `set -x` if needed
|
||||
4. **Is there a design flaw in the skill?** — Does the logic actually cover this scenario?
|
||||
|
||||
### 3. 定位到文件
|
||||
### 3. Pinpoint the File
|
||||
|
||||
- 确认问题出在哪个文件的哪一行
|
||||
- 如果是 skill 本身的问题 → 进入 [improve-skills](./improve-skills.md) 流程
|
||||
- 如果是脚本执行环境问题 → 记录在 memory/ 并提给 hang
|
||||
- Identify which file and which line the problem is in
|
||||
- If it's a skill issue → follow the [improve-skills](./improve-skills.md) workflow
|
||||
- If it's an execution environment issue → document in memory/ and escalate to hang
|
||||
|
||||
### 4. 修复
|
||||
### 4. Fix
|
||||
|
||||
- 在本地测试修复方案
|
||||
- 如果需要修改 skill 文件 → 按 improve-skills 流程提交 PR 或直接 push 到分支
|
||||
- 避免引入新的 side effect
|
||||
- Test the fix locally
|
||||
- If skill files need to be modified → follow improve-skills process to PR or push to a branch
|
||||
- Avoid introducing new side effects
|
||||
|
||||
### 5. 验证
|
||||
### 5. Verify
|
||||
|
||||
- 复现原场景,确认问题已解决
|
||||
- 记录修复内容到 memory/YYYY-MM-DD.md
|
||||
- Reproduce the original scenario; confirm the issue is resolved
|
||||
- Log the fix in memory/YYYY-MM-DD.md
|
||||
|
||||
### 6. 上报(如需要)
|
||||
### 6. Escalate if Needed
|
||||
|
||||
- 如果问题需要 hang 或其他 agent 介入 → 在 report channel 记录
|
||||
- 包含:场景、期望/实际结果、根因、修复方案
|
||||
- If the issue requires hang or another agent → post in report channel
|
||||
- Include: scenario, expected/actual result, root cause, fix applied
|
||||
|
||||
Reference in New Issue
Block a user