补丁 & 提交
提交补丁
在前几次修改手册时,你需要提交补丁给管理员审查。这只是为了确保维护的用户手册的高品质,以及避免你在熟悉这套系统之前,不小心破坏了一些重要内容。
为了提交补丁,请遵循以下流程:
按照自己的想法进行修改。
创建一个补丁文件,运行
svn diff > filename.diff
这将创建一个文本,记录你在工作文件和中央仓库之间对文件进行添加、删除和修改的内容。
如果您已创建或删除文件,你需要在创建差异文件前,运行
svn add /path/to/file
或者svn rm /path/to/file
。运行svn status
,可以查看受影响的文件列表。提交差异文件后,将要求你 "创建一个新的修改" ,然后就可以添加关于更改的标题和描述。
为了提示文档团队处理你的补丁,注意检查
Tags
文本框是否有指定为文档项目。你也可以在邮件列表或 Blender 讨论 中 联系 团队。他们将审核您的补丁,并让您知道您可以进行的任何更改。如果没有问题,您的补丁将被接受,然后由您的补丁团队提交。
Note
如果你的补丁包含图片的修改和添加,只需在创建修改时作为附件插入即可。
直截了当的补丁很快就会被接受。一旦你适应了修改流程并且不再需要反馈之后,我们将去掉中间环节,赋予你直接编辑手册的权限。
See also
请参阅 发布周期 了解有关如何提交到特定发布分支以及如何创建合并提交文档。
直接提交
获得编辑手册的直接访问权限后,您可以开始直接提交,而不是创建补丁。这样做将直接将更改提交到我们的中央存储库。
你现在只需运行:
svn commit -m "This is what I did"
如果你省略了 -m ``message``
,将提示你在文本编辑器中输入留言。
不要忘记在提交前运行 svn update
。
然后,在提交更改之前,系统将要求您输入用户名和密码(来自 "developer.blender.org" )。
Note
请务必使用您的用户名(区分大小写) ,而不是您的电子邮件。
你修改过的文件被上传到中央仓库,供其他人继续参与和编写。提交可在仓库的 Diffusion 中追踪。很快你的修改就会呈现于在线手册中了。
写一个好的承诺信息
当对手册进行与Blender中的特定提交(更改)直接相关的更改时,将提交标题与提交给Blender的标题相同很有帮助。要求您包含对Blender源代码所做的提交的提交哈希。
例如,提交 rBM8473 包括指示与散列 rBa71d2b260170
一起做出的改变的描述性说明。可以从文档任务中为即将发布的特定版本提供的URL中提取哈希。
其他更一般的变更不必遵循上述政策,但仍有必要明确说明您所做的变更及其原因。当您分别进行常规清理或修复时,使用前缀词(如 "清理:" 或 "修复:" )来前缀提交标题可能会有所帮助。
编写好的提交消息有助于管理员跟踪所做的更改,并确保所有新功能都得到正确记录。