如何在 GitHub 上的 PR 中隐藏生成的文件？

Question

当我要在 GitHub 上审查拉取请求时，我会查看更改的代码行，以了解审查的耗时程度。 然而，许多项目包含一堆生成的文件，不应手动检查。

以这个PR为例。 它更改了一些模型实现，然后由数据类生成器freezed生成。
我只想审查人类编写的代码并相信生成器的输出是正确的。

GitHub 中是否有任何方法可以选择要包含在代码审查中的文件，以便更新要审查的代码行并反映要完成的工作？

Answer 1

是的，GitHub 提供了一种将某些文件标记为“生成”的方法，然后默认情况下可以将其隐藏在差异中，使您在审查期间更轻松地专注于人工编写的代码。您可以通过使用存储库根目录中的

.gitattributes

文件来实现此目的。设置方法如下：

1. 在存储库的根目录中创建一个

   .gitattributes

   文件（如果尚不存在）。

2. 使用

   linguist-generated

   属性来标记您希望忽略差异的路径。例如，要将目录中的所有文件标记为已生成，您可以将以下行添加到您的

   .gitattributes

   文件中：

path/to/generated/files/* linguist-generated=true

3. 提交

   .gitattributes

   文件并将其推送到您的存储库。

完成此操作后，标记的文件将默认折叠在 GitHub 上的拉取请求差异视图中，您无需手动筛选它们。但是，它们仍然是拉取请求的一部分，并且可以根据需要进行扩展。

此外，您可以使用拉取请求的“文件已更改”选项卡中的文件过滤器下拉菜单，按扩展类型、代码所有权或其他条件过滤文件²。这可以进一步帮助您在代码审查过程中专注于需要您注意的文件。

请记住，这些设置将影响文件在 GitHub 上查看存储库的每个人的差异中的显示方式，因此最好确保您的团队了解这些更改。如果您在设置方面需要进一步帮助或有任何其他问题，请随时询问！