baa-conductor

BUG-TEMPLATE.md

 1# BUG-XXX: 简短标题
 2
 3## 现象
 4
 5清楚描述可观察到的问题现象。
 6
 7建议包含：
 8
 9- 哪个接口 / 页面 / 脚本出问题
10- 返回了什么
11- 预期应该是什么
12- 是否稳定复现
13
14## 触发路径
15
16写清楚最短触发链路，例如：
17
18```text
19POST /v1/exec
20-> 某个 shell 命令
21-> 某个脚本
22-> 失败 / 超时 / 错误返回
23```
24
25## 根因
26
27如果已经确认根因，就直接写。
28
29如果还没完全确认，可以写：
30
31- 当前判断
32- 高概率根因
33- 仍需验证的点
34
35## 复现步骤
36
37给出别人可以直接照抄的最小复现步骤。
38
39示例：
40
41```bash
42curl -s http://100.71.210.78:4317/some/endpoint \
43  -X POST \
44  -H 'Content-Type: application/json' \
45  -d '{"foo":"bar"}'
46```
47
48## 当前影响
49
50写清楚影响面：
51
52- 是否影响主流程
53- 是否只影响某类目录 / 某类脚本 / 某个页面
54- 是完全不可用还是降级可用
55
56## 修复建议
57
58如果已经有候选方案，按顺序写：
59
60### 方案 A（推荐）
61
62写最直接、最建议的修法。
63
64### 方案 B
65
66写备选方案。
67
68### 方案 C
69
70如果有额外兜底方案再写。
71
72## 严重程度
73
74从下面选一个，并简单解释：
75
76- Low
77- Medium
78- High
79
80## 发现时间
81
82格式建议：
83
84`YYYY-MM-DD by <发现者>`
85
86例如：
87
88`2026-03-22 by Codex`
89
90## 备注
91
92可选。
93
94写一些不适合放在上面结构里的补充信息，例如：
95
96- 临时绕过方式
97- 是否已经在线上观察到
98- 是否已有相关日志文件