先照抄一个
最短的写法
/pstack:poteto-mode 重试之后用户会收到两条通知。先复现,再修,再验证。「复现」就是让问题再出现一次。它会先把问题跑出来。跑不出来,它就不改代码。
这个顺序是固定的:先复现,找到真正的原因,再修,最后用同一个步骤验证。
- 1先复现让问题再出现一次
- 2找真正的原因第一个出错的地方
- 3修在那里不在后面补判断
- 4同一个步骤再跑问题不再出现
线索多给一点
完整的写法
/pstack:poteto-mode 从昨天发版之后,导出 CSV 会丢最后一行。失败的任务 id 是 4812。先复现,再修。修好的标准是那份 6 万行的测试数据导出后一行不少。把修之前和修之后的行数给我看。每一部分管一件事:
- 症状和开始时间:发版之后,导出丢最后一行。
- 你手上的线索:任务 id。它能少找一轮。
- 怎么算修好:6 万行导出后一行不少。
- 做完给我看什么:修前修后的行数。
Chrome 插件的例子
用户反馈:侧边栏收藏的条目,刷新后偶尔会重复。
Chrome 插件的例子
/pstack:poteto-mode 用户反馈:侧边栏收藏列表刷新后偶尔会出现重复条目。
我自己试过,连点两次「收藏」比较容易出现。先复现,不要先改代码。
修好的标准:连点十次收藏,列表里只有一条,chrome.storage 里也只有一条。
给我看修之前和修之后 storage 里的实际内容。- 「storage 里也只有一条」:界面可能去了重,数据里还是两条。所以要看真正存下来的值。
- 「连点十次」:把「偶尔」变成每次都能判断过不过的检查。
发出去以后看哪里
开头:它的复述。 它说的问题和你说的不一样,就马上打断。
中间:待办清单。 它会列几个可能的原因,一个个排除,找到第一个出错的地方。修就该改在那里,不是在后面补判断。
最后:修前修后的对比。 用的是同一个复现步骤。
好写测试的 bug:加 /pstack:tdd
复制下面这段
/pstack:poteto-mode 先复现重复写入。如果有便宜的测试路径,就 /pstack:tdd:先写一个会失败的测试,再修,再跑一遍。「如果有便宜的测试路径」不能省。靠一堆假数据硬撑的测试,还不如直接跑真实命令有说服力。
卡住了?
它说复现不出来。
这是好事,说明它没瞎改。把环境说具体:哪个页面、什么数据、点了什么、什么版本。也可以贴日志或录屏。
它说「已修复」,但没给证据。
回它:「apply prove it works. 跑一遍复现步骤,把真实输出给我看。」prove it works 的意思是:拿真实结果证明它能用。这是 pstack 认识的一条原则名,原样打出来它就懂。
它在后面加了一个 if 判断,就说修好了。
回它:「fix root causes. 这个状态本来不该出现,找到它第一次出错的地方。」fix root causes 意思是修真正的原因,也是一条原则名。只有那个状态本来就合法,加判断才算修。