Patch & Commit

Submit Patches

The first few times you make changes to the manual, you will need to submit them as patches for an administrator to review. This is just to make sure that we maintain a quality user manual, and that you do not accidentally break anything vital before you get used to the system.

In order to submit a patch, follow this process:

Make any changes that you want.
Create a patch file by running:
```
svn diff > filename.diff
```
This creates a simple text file that shows what text was added, removed or changed between your working files and the central repository.

If you have created or deleted files, you will need to run svn add /path/to/file or svn rm /path/to/file before creating the diff. To see a list of affected files, run svn status.
Upload the diff file here. If you do not have an account already, you can register for one.
After submitting the diff, you will be asked to "Create a new Revision" before you can add a title and description of your changes.
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.
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.

Ghi chú

If your patch includes changes to or additional images, simply attach them when you are creating the revision.

Straightforward patches are bound to be accepted very quickly. Once you get accustomed to making changes and no longer need feedback, we cut out the middle man and give you direct access to edit the manual.

Xem thêm

See Release Cycle for documentation on how to make commits to a specific release branch and how to create merge commits.

Commit Directly

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.

All you need to do now is run:

svn commit -m "This is what I did"

Nếu bạn không đánh '"thông điệp"' thì bạn sẽ được nhắc nhở là bạn cần phải nhập thông điệp trong một trình biên soạn văn bản riêng.

Do not forget to always run svn update before committing.

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

Ghi chú

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

Your modified files are uploaded to the central repository for others to work with and continue collaborating. Commits are tracked in the repositories Diffusion. Soon after your changes become visible in the online manual.

Viết Thông Điệp Miêu Tả Thay Đổi Chuyển Giao Kho Lưu Trữ Đúng Đắn (Writing a Good Commit Message)

Khi thực hiện các thay đổi đối với bản hướng dẫn sử dụng, và những thay đổi này liên quan trực tiếp đến một commit cụ thể nào đó trong Blender thì việc giữ cho tiêu đề của commit hoàn toàn giống với commit đã thực hiện trong Blender, là một việc rất hữu dụng. Chúng tôi yêu cầu là bạn phải kèm commit hash của bản Chuyển Giao Thay Đổi vào Kho Lưu Trữ đã Thực Hiện trước đây cho Mã Nguồn Blender.

Ví dụ, commit rBM8473 chẳng hạn, commit này bao gồm một miêu tả về những thay đổi đã được thực hiện, cùng với mã băm rBa71d2b260170. Chúng ta có thể trích xuất mã băm ra khỏi địa chỉ URL cung cấp trong Tác Vụ Viết Tài Liệu cho một bản phát hành cụ thể sắp tới nào đó.

Những thay đổi có tính chất chung chung hơn khác sẽ không phải tuân theo chính sách nói đến ở trên. Điều quan trọng là phải miêu tả rõ ràng những thay đổi bạn đã thực hiện và nguyên nhân tại sao. Việc điền một tiền tố cho tiêu đề commit"Dọn Dẹp:" tiề"Sửa Chữa:" Dọn Dẹp (Cleanup): hoặc Sửa Chữa (Fix):, khi bạn thực hiện các dọn dẹp, hoặc các sửa chữa chung chung tương ứng, có thể là một điều hữu ích, nên làm.

Viết thông điệp commit tốt sẽ giúp các quản trị viên theo dõi các thay đổi đã thực hiện và đảm bảo rằng: toàn bộ các tính năng mới đã được ghi lại đường hoàng.