第一次提交前看什么

「第一次提交前看什么」。

差异、不该提交的文件、能不能在干净目录跑起来。三件事做完再推。

先留现场,再动手。把当时的输入、输出、配置名抄下来,确认同一条路径还能再出现一次。不能再出现的现象,改完也不知道是不是改对了。确认之后只改一处。改两处的话,结果变了也分不清是哪一处。改完用同一组输入再走,结果要变成预期的那样,而不是仅仅没有报错。

这篇按可以照着做的顺序写。每一步都写期望看到什么,不写‘然后应该就可以了’。出错时先留下完整输出、当时的配置、你期望发生什么。说明放在仓库里,不放在聊天记录里。给别人之前,在干净目录自己走一遍。

判断分两层。第一层是现象:什么时候开始、影响谁、能不能再出现。第二层才是原因。很多时间浪费在还没写清现象就改代码。原因确定之后,改动尽量小,并写明怎样一分钟内确认它生效。确认不了的改动先不要合。

复查「第一次提交前看什么」时按这四步,不靠感觉。用改之前的同一组输入再走一遍,结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名,确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。

补充记录。步骤按别人能跟着做来写。每一步只有一个动作,并写明做完应该看到什么。看不到就停,不要写‘然后应该就可以了’。开始前列出需要的运行时和配置样例,样例用假值。结束前在干净目录自己走一遍,走不通就改步骤,不增加口头补充。出错时要求留下三样:完整输出、当时的配置、期望结果。说明放在仓库,不放在聊天。第一周的目标只到能跑、能提交、知道去哪问,不要把整套结构塞进第一篇。

操作顺序。1. 写明给谁看,以及做完他能做什么。2. 列出运行时和一份用假值填好的配置样例。3. 每步只有一个动作,并写期望看到的输出。看不到就停在这一步。4. 在干净目录自己走完全程。5. 把走不通的地方改步骤,而不是在聊天里补一句。6. 出错时要求留下完整输出、配置和期望。7. 说明随代码放进仓库。第一周只要求能跑起来、能提交、知道去哪问,不把整套结构放进第一步。

3 个赞

推送前在干净目录装一遍。装不上,就还不能交给别人。

1 个赞