GitHub Pull Request 写作指南：规范、完整、易懂

如何写一份规范的 GitHub Pull Request

写一份规范的 GitHub Pull Request 能够帮助其他开发者更好地理解你的代码，并提高代码审查和合并的效率。以下是一份详细的步骤指南：

Fork 目标项目并克隆到本地：确保你拥有目标项目的副本，并在本地进行代码修改。
修改代码并进行本地测试：在本地修改代码并进行充分的测试，确保修改的正确性和完整性。
添加注释和文档：为你的代码添加详细的注释和文档，帮助其他开发者理解你的代码逻辑和意图。
Commit 修改并写明清晰的 Commit Message：使用清晰且简洁的 Commit Message 描述你的修改内容，以便其他开发者快速了解你的改动。
Push 修改到你的 Forked 仓库：将本地修改 push 到你的 forked 仓库，以便在 GitHub 上创建 Pull Request。
创建 Pull Request 并完善信息:
- **标题：**简短清晰地描述你的修改内容。
- **描述：**详细说明你的修改内容，包括修改的思路、目的和解决的问题。
- **提交信息：**列出你的修改内容和对应的 Commit Message。
- **测试：**列出你在本地进行的测试，以及测试结果。
- **问题和限制：**列出你的修改中可能存在的问题和限制，以及需要关注的点。

TensorFlow 仓库是一个非常流行的机器学习框架，它遵循很多开源社区的最佳实践。其 Pull Request 非常规范，每个 Pull Request 都拥有清晰的标题和描述，并包含相关的测试和问题列表。

通过遵循以上步骤和参考优秀案例，你能够写出更加规范、完整、易懂的 GitHub Pull Request，提高代码贡献效率，促进协作和代码质量。