跳至主要内容

仓库最佳实践

了解如何高效且安全地使用仓库。

创建 README 文件

为方便他人理解和浏览你的工作,我们建议为每个仓库创建 README 文件。

你可以在仓库中添加 README 文件,以传达项目的重要信息。README 与仓库许可证、引用文件、贡献指南以及行为准则一起,阐明项目预期并帮助你管理贡献。更多信息,请参阅 关于仓库的 README 文件

确保仓库安全

你应使用 GitHub 提供的安全功能来保护代码,防止漏洞、未授权访问以及其他潜在的安全威胁。至少,你应启用以下功能,这些功能对 公共仓库免费

  • Dependabot 警报会通知你项目依赖网络中的安全漏洞,以便你将受影响的依赖更新到更安全的版本。
  • 机密扫描会检查仓库中的机密(如 API 密钥和令牌),并在发现机密时提醒你,以便你将其从仓库中移除。
  • 推送保护通过阻止包含受支持机密的推送,防止你(及协作者)在第一时间向仓库引入机密。
  • 代码扫描会识别仓库代码中的漏洞和错误,让你及早修复这些问题,防止漏洞或错误被恶意行为者利用。

此外,你还可以考虑

  • 在仓库中添加 SECURITY.md 文件。SECURITY.md 文件向协作者提供报告项目中发现的安全漏洞的指引,并鼓励负责任的披露。
  • 为仓库启用“私密漏洞报告”,让协作者和安全研究人员可以私下向你披露在仓库中发现的漏洞。

更多信息,请参阅 仓库安全快速入门

优先使用分支而非派生

为简化协作,我们建议常规协作者在同一仓库中工作,通过分支之间的拉取请求(pull request)进行合并,而不是跨仓库的拉取请求。派生更适合接受与项目无关联的人员的贡献,例如开源贡献者。

在使用分支工作流的同时,为了保持重要分支(如 main)的质量,你可以使用受保护分支并设置必需的状态检查和拉取请求审查。更多信息,请参阅 关于受保护分支

使用 Git 大文件存储

为提升性能,GitHub 对仓库中允许的文件大小有限制。更多信息,请参阅 关于 GitHub 上的大文件

要在 Git 仓库中跟踪大文件,我们建议使用 Git 大文件存储 (Git LFS)。更多信息,请参阅 关于 Git 大文件存储

实战练习

尝试 仓库管理入门 Skills 练习,获取仓库管理的实战经验。

© . This site is unofficial and not affiliated with GitHub, Inc.