如何写一份规范的提交到GitHub的Pull Request请给我一个优秀的github仓库
写一份规范的提交到GitHub的Pull Request的步骤如下:
-
确保你已经fork了目标项目,并且将其clone到本地。
-
在本地修改代码并在本地进行测试。
-
添加注释和文档以便其他开发者可以理解你的代码。
-
commit你的修改,并且在commit message中清晰地描述你的修改。
-
push你的修改到你的forked仓库中。
-
在GitHub上创建一个Pull Request,确保你的Pull Request中包含以下信息:
- 标题:简短清晰地描述你的修改。
- 描述:详细说明你的修改和你的思路。
- 提交信息:列出你的修改和你的提交信息。
- 测试:列出你在本地进行的测试,以及测试的结果。
- 问题和限制:列出你的修改中可能存在的问题和限制。
以下是一个优秀的GitHub仓库示例:https://github.com/tensorflow/tensorflow
这个仓库是一个非常流行的机器学习框架,它遵循了很多开源社区的最佳实践。它有一个清晰的项目结构和文档,有一个完整的贡献指南,以及一个活跃的社区。它的Pull Request也非常规范,每个Pull Request都有一个清晰的标题和描述,以及相关的测试和问题列表。
原文地址: https://www.cveoy.top/t/topic/YnO 著作权归作者所有。请勿转载和采集!