补丁 & 提交

提交补丁

在前几次修改手册时，你需要提交补丁给管理员审查。这只是为了确保维护的用户手册的高品质，以及避免你在熟悉这套系统之前，不小心破坏了一些重要内容。

为了提交补丁，请遵循以下流程：

  1. 按照自己的想法进行修改。

  2. 创建一个补丁文件，运行

    svn diff > filename.diff

    这将创建一个文本，记录你在工作文件和中央仓库之间对文件进行添加、删除和修改的内容。

    如果您已创建或删除文件，你需要在创建差异文件前，运行 svn add /path/to/file 或者 svn rm /path/to/file 。运行 svn status ，可以查看受影响的文件列表。

  3. 在这里上传差异文件 。如果你还没有账号，可以 注册一个 。

  4. 提交差异文件后，将要求你 “创建一个新的修改” ，然后就可以添加关于更改的标题和描述。

  5. 为了提示文档团队处理你的补丁，注意检查 Tags 文本框是否有指定为文档项目。你也可以在邮件列表或 Blender Chat 中 联系 团队。

  6. They will review your patch and let you know about any changes you could make. If there is no issue, your patch will be accepted and then committed by the team of your patch.

Note

如果你的补丁包含图片的修改和添加，只需在创建修改时作为附件插入即可。

直截了当的补丁很快就会被接受。一旦你适应了修改流程并且不再需要反馈之后，我们将去掉中间环节，赋予你直接编辑手册的权限。

See also

See 发布周期 for documentation on how to make commits to a specific release branch and how to create merge commits.

直接提交

获得编辑手册的直接访问权限后，您可以开始直接提交，而不是创建补丁。这样做将直接将更改提交到我们的中央存储库。

你现在只需运行:

svn commit -m "This is what I did"

如果你省略了 -m "message" ，将提示你在文本编辑器中输入留言。

不要忘记在提交前运行 svn update 。

Then you will be asked for your username and password (from developer.blender.org) before the change is committed.

Note

Make sure to use your username (case sensitive) and not your email.

你修改过的文件被上传到中央仓库，供其他人继续参与和编写。提交可在仓库的 Diffusion 中追踪。很快你的修改就会呈现于在线手册中了。

Writing a Good Commit Message

When making changes to the manual that directly relate to a specific commit (change) in Blender, it is helpful to make the title of the commit the same as the commit made to Blender. It is requested that you include the commit hash of the commit made to the Blender source code.

For example, the commit rBM8473 includes a descriptive indicative of the changes made along with the hash rBa71d2b260170. The hash can be extracted from the URL provided in the Documentation task for a specific upcoming release.

Other more general changes do not have to follow the above policy however, it is still important to make the description clear about what changes you made and why. It can be helpful to prefix the commit title with a prefix word such as Cleanup: or Fix: when you are making general cleanups or fixes respectively.

Writing good commit messages helps administrators keep track of changes made and ensures all new features are properly documented.