「感谢里写上用到的项目」。
不是客套。以后自己也找得到当时为什么选它。
记录里保留失败的那一次。只写成功,别人学不到边界。失败时的输出、当时的配置、本来期望发生什么,三样放在一起。修好之后补一句:如果再出现,先看哪一行。没有这句,这篇就只是故事。
用进项目之前看三件事:最后一次提交、协议、讨论区里是不是反复同一个坑。只为了一个小功能引进一整套,通常不划算。大版本先读迁移说明,在分支上试。锁文件要提交。给上游提修改时按他们的格式来。选它的理由写下来,几个月后会忘记。
这次按时间写。先发生什么,中间查了什么,最后留下什么。不把后来才知道的结论写成一开始就想到了。查的时候把猜的和已经验证的分开,避免第二天把猜测当成事实。验证用的是改之前的同一条路径,不是换一组更容易过的输入。
复查「感谢里写上用到的项目」时按这四步,不靠感觉。用改之前的同一组输入再走一遍,结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名,确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。
补充记录。引进之前写三行:最后一次提交是什么时候,协议允不允许我们这样用,讨论区是不是反复同一个安装坑。三行有任何一行过不了,就先不要引进。只为了一个小功能而背上整套概念,后面会在升级和安全更新上还债。大版本单独开分支,按迁移说明试,默认值可能和以前相反。锁文件和代码一起提交,保证别人装到同一版。给上游提修改时先读他们的贡献说明,格式和测试按他们的来。选它而不选另一个的理由写在仓库里,几个月后没人记得。
操作顺序。1. 看最后一次提交日期和未关闭的讨论。2. 读协议,确认我们的用法在范围内。3. 只取需要的功能,关掉其余默认项。4. 大版本先在分支按迁移说明试,不直接升。5. 锁文件和代码一起提交,并用干净目录安装一次。6. 要改上游就先读贡献说明,按他们的测试和格式提交。7. 在仓库写三行:为什么选它、什么时候再评估、谁负责升级。没有这三行,半年后没人敢动它,也没人敢换掉它。