创建 README 文件
为了让人们更容易理解和浏览你的工作,我们建议你为每个存储库创建一个 README 文件。
你可以将 README 文件添加到存储库中,以传达有关你的项目的重要信息。README 以及存储库许可证、引用文件、贡献指南和行为准则传达了对你的项目的期望,并帮助你管理贡献。有关更多信息,请参阅“关于 README”。
优先分支而不是分叉
为了简化协作,我们建议定期协作者从单个存储库工作,在分支之间(而不是在存储库之间)创建拉取请求。分叉最适合接受与项目无关的人(例如开源贡献者)的贡献。
要维护重要分支(例如 main
)的质量,同时使用分支工作流,可以使用受保护分支,其中需要状态检查和拉取请求审查。有关详细信息,请参阅“关于受保护分支”。
使用 Git 大文件存储
为了优化性能,GitHub.com 限制了存储库中允许的文件大小。有关详细信息,请参阅“关于 GitHub 上的大文件”。
要在 Git 存储库中跟踪大文件,我们建议使用 Git 大文件存储 (Git LFS)。有关详细信息,请参阅“关于 Git 大文件存储”。