选择你需要支撑的段落
假设你在文章中提到自己项目公开 README 里的一条安装说明,事先要核对它。找到确切的段落及其附近的条件。仓库标题或个人简介不能替代包含该声明的文件。
把任务限定在文档范围内。你不需要运行项目、查看个人联系方式,也不应把贡献者的账号当作其私人身份的证明。
用版本链接替换会变化的分支视图
GitHub 说明,普通文件视图通常显示分支的当前最新提交,因此内容会随提交而变化。查看文件时按 y 键,URL 会变为使用特定提交而非分支名的永久链接。来源
复制操作后实际显示的 URL。重新打开它,确认显示的是同一文件和段落。不要编造提交标识符,也不要根据未打开过的搜索预览来构造引用。
如果你还想保留当前分支地址,请另做记录。版本链接回答的是“我检查的是哪段措辞?”,而分支视图让你查看项目现在呈现的内容。
为其他读者记录足够的上下文
| 字段 | 从你的检查中记录 | 用途 |
|---|---|---|
| 仓库与文件 | 实际项目及文件路径 | 标识所引用的文档 |
| 提交标识符 | 复制的永久链接中的版本 | 将此快照与后续编辑区分开 |
| 支撑段落 | 简短摘录或忠实摘要 | 将声明限定在已检查的措辞内 |
| 附近条件 | 版本、环境或功能限制 | 避免遗漏限定条件 |
| 访问日期 | 你打开来源的时间 | 将你的查阅时间与发布历史分开 |
举例来说,若某个 README 称导出功能为实验性,受支撑的陈述应保留“实验性”一词。稳定的 URL 并不能成为将其改写为经过测试的保证的理由。此示例仅说明引用做法,并非关于真实仓库的报告。
判断旧声明是否仍然相关
如果当前分支有所不同,请保留两项观察:你引用的较早版本,以及你实际打开的当前措辞。不要在继续将其描述为同一次查阅的同时,悄悄替换较早的引用。
文件中可能包含计划、示例或过时的说明。应将这些陈述归于项目,而不是声称你独立测试了实现。如果之后访问失败,请记录该限制;版本标识符并不承诺永久托管或访问权限。
这也与签名提交徽章不同。GitHub Verified 徽章指南讨论的是另一种信号。若要对公开文档做更广泛的综合,请使用 AI 来源审查清单,并保留每项重要声明所依据的确切版本。