拉取请求#

本页面介绍了用于代码提交与评审的工具。

代码评审是确保代码变更质量的关键措施。它有助于防止缺陷、保持设计一致性，并避免潜在的维护问题。此外，让他人审查您的工作通常也能让您时刻保持警惕。

Note

获得提交权限的开发者无需仓库分支即可直接向主仓库提交代码。

如果这适用于您，可参阅提交指南。

一次性设置#

这假设您已经按照安装说明，在计算机上检出了 Blender 手册代码库。

派生（Fork）#

  1. 访问 Blender 代码库，然后点击派生按钮。

  2. 使用默认设置确认分支。

  3. 现在，您需要将您的个人分支作为远程仓库添加到本地 Git 仓库中。点击 SSH 查看正确的 URL，然后按照以下方式添加：

    git remote add me [email protected]:<USERNAME>/blender-manual.git

Note

要向分支仓库推送代码，您需要一个 SSH 密钥。如果您还没有 ~/.ssh/id_rsa.pub 这个文件，可以使用以下简单命令生成此类密钥，该命令在 Linux、macOS 以及 Windows 上的 Git Bash 中均可使用:

ssh-keygen

该命令将在 ~/.ssh 目录下生成一个私钥 id_rsa 和一个公钥 id_rsa.pub．为避免账户安全受到威胁，切勿向任何人展示或发送私钥，但可以安全地分享公钥。

将 ~/.ssh/id_rsa.pub 中的内容复制并粘贴到 projects.blender.org 上的账户设置中，此前请先点击 “增加密钥”。SSH 密钥的名称可以任意设定。

工作流程#

有关处理拉取请求的工作流程，请参阅 Blender 开发者文档。

请注意，上述指南中的部分内容主要针对 Blender 主仓库，但该工作流程适用于任何 Blender 项目。

审查者指南#

  • 拉取请求的正文应可直接用作 Git 提交信息（详情请参阅指南）。

  • 如果某些更改需要在提交前处理，且无需经过评审环节，请明确说明。

  • 如果拉取请求未获批准，则作者应进行新一轮修改。

  • 如果该更改需要先就设计任务达成一致，请在标题前添加 WIP: 前缀，将拉取请求置于待处理状态，以此表明提交者认为该拉取请求尚未准备好合并。除非提交者明确要求，否则不会进行审核。

  • 作者应在 3 个工作日内回复拉取请求。

  • 将相关的模块/项目添加到标签中。

  • 鼓励新作者参与评审，这既是学习的好方法，对项目的成长也至关重要。

提示#

  • 要获取补丁文件，请在拉取请求的 URL 末尾添加 .patch．示例:

    https://projects.blender.org/blender/blender-manual/pulls/104892.patch

  • 将拉取请求合并到脱离分支的头部（不留下分支）。示例:

    git fetch -q origin +refs/pull/104892/head: ; git checkout -qf FETCH_HEAD