修補和交付

提交修補檔

在前幾次修改手冊時，你需要提交修補檔給管理員審查。這只是為了確保使用手冊的品質，以及避免你在熟悉這套系統之前，不小心破壞了一些重要內容。

為了提交修補檔，請遵循以下流程：

  1. 按照你的想法進行修改。

  2. 執行下列命令建立一個修補檔:

    svn diff > filename.diff

    這將建立一個文字檔，記錄你的工作檔對中央存放區內，文字內容的增加、刪除和修改。

    如果您有建立或刪除檔案，你需要在建立差異檔案前，先執行 svn add /path/to/file 或者 svn rm /path/to/file 。查看受影響的文件列表，執行 svn status 。

  3. 在這裡上傳差異檔案 。如果你還沒有帳號，可以 註冊一個.

  4. 提交差異檔案後，你將被要求 "建立一個新的修改" ，然後就可以增加關於更改的標題和描述。

  5. Please check if the Documentation project is assigned in the tag's field in order to notify the team of your patch. You can also contact the team over the mailing list or 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 Release Cycle for documentation on how to make commits to a specific release branch and how to create merge commits.

直接交付

Once you are provided with the direct access to edit the manual, you can start committing directly instead of creating a patch file. Doing this will submit the change directly to our central repository.

你現在只需執行：

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.