Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2024-09-25. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

存储库最佳做法

了解如何最有效地使用存储库。

创建 README 文件

为了便于用户理解和导航你的工作,建议为每个存储库创建一个 README 文件。

您可以将 README 文件添加到仓库来交流有关您项目的重要信息。 自述文件以及存储库许可证、引文文件以及贡献指南传达了对项目的期望,并有助于管理贡献。 有关详细信息,请参阅“关于自述文件”。

优选分支而不是分叉

为了简化协作,建议常规协作者从单个存储库工作,在分支之间而不是存储库之间创建拉取请求。 分叉最适合接受与项目无关的人员(如开源参与者)的贡献。

若要在使用分支工作流时保持重要分支(如 main)的质量,可以使用受保护的分支进行所需的状态检查和拉取请求评审。 有关详细信息,请参阅“关于受保护分支”。

使用 Git Large File Storage

为了优化性能,GitHub 会限制存储库中允许的文件大小。 有关详细信息,请参阅“关于 GitHub 上的大文件”。

若要跟踪 Git 存储库中的大型文件,建议使用 Git Large File Storage (Git LFS)。 有关详细信息,请参阅“关于 Git Large File Storage”。