代码考古(git + 仓库内)
代码考古(git + 仓库内)
Section titled “代码考古(git + 仓库内)”这个来源里有什么
Section titled “这个来源里有什么”- 提交历史(信息、日期、作者、diff)
- PR 描述、评审评论、讨论串(通过
gh) - 行内代码注释、TODO、FIXME、弃用说明
- ADR(架构决策记录),若仓库有维护
- 测试。名称和断言常常记下促使这次改动的边界情况
- 同提交中修改的相关文件(共变信号)
- 仓库里的 CHANGELOG 条目和发布说明
- 提交说明和 PR 正文里的工单 ID
最可信、与代码直接绑定,也最完整。经仓库的一切应在此。
扩展种子提交列表:
# 含重命名的历史git log --follow --oneline -- <file>
# Pickaxe:添加或删除某段精确文本的提交git log -S '<exact_string_from_code>' -- <file>
# 或按模式:git log -G '<regex>' -- <file>
# 每行作者与时间git blame -L <start>,<end> <file>
# 一次提交的完整 diffgit show <hash>
# 两时间点之间影响该文件的提交git log <old>..<new> -p -- <file>对每个实质性提交,拉取 PR 上下文:
# 从合并提交或分支得到的 PR 编号git log -1 --format=%B <hash>
# 正文、评审评论、关联 issue。有讨论的 PR 里,reviews 和 comments 才是真正的信号gh pr view <number> --json title,body,author,createdAt,mergedAt,labels,closingIssuesReferences,comments,reviews,files查找仓库外文档:
# ADR 常在 docs/adr/ 等rg -l -i 'architecture.decision' --glob '*.md'
# 目标附近的 TODO 与 FIXMErg -n -C2 '(TODO|FIXME|HACK|XXX|NOTE)' <target_file>
# 相关测试rg -l '<symbol>' --glob '*test*'这里怎样算好证据
Section titled “这里怎样算好证据”- 解释问题本身、而不只是改动的 PR 描述(「修复导致 X 的分页 bug」)
- 长篇评审串,其中辩论了替代方案
- 目标行附近解释非显然约束的行内注释
- 名为
test_handles_edge_case_when_X的测试,点出促使这段代码出现的边界情况 - 引用工单或事故 ID 的提交信息
- 概括用户可见理由的 CHANGELOG 条目
- Squash 合并后变平。 squash 过的 PR 会丢掉分支上的提交。退回到 PR 正文和评论。
- 误导性提交信息。 「小重构」有时掩盖有意行为变更。看 diff,不要只看信息。
- 照搬来的模式。 作者可能复制了一种模式,自己也不清楚原因。去查它是不是更早在代码库里出现过,然后调查那次提交。
- Bot 提交和自动合并。 Dependabot、Renovate 和自动 backport 通常不带动机。找意图时跳过它们。
- 把代码当意图的证据。 代码不能证明它为何存在。证据来自提交说明、PR、评论、测试和文档。不要把「函数名叫 X」当成意图的证据。
每条与问题相关的提交/PR/评论,含:
- 确切文本(引用)
- hash / PR 编号 / file:line
- 作者与日期
- 是直接(直接回答问题)还是旁证
