Chắp Vá và Chuyển Giao Sửa Đổi (Patch & Commit)
Đệ Trình các bản chắp vá (Submit Patches)
Một vài lần đầu thực hiện các thay đổi trong sách hướng dẫn, bạn sẽ cần phải gửi chúng đến dưới dạng một bản chắp vá để quản trị viên xét duyệt. Điều này chỉ là để nhằm đảm bảo rằng chúng tôi duy trì bản hướng dẫn sử dụng với chất lượng tốt, và rằng, bạn sẽ không vô tình mà làm hỏng bất cứ một điều gì trọng yếu, trước khi bạn trở nên thành thục với hệ thống, mà thôi.
Để gửi bản liệt kê các sửa đổi, xin hãy làm theo quy trình sau đây:
Thực hiện bất kỳ thay đổi nào mà bạn mong muốn.
Tạo patch bằng cách thi hành:
svn diff > filename.diff
Điều này tạo ra một tập tin văn bản đơn giản, cho thấy văn bản nào đã được cho thêm vào, xóa đi hoặc thay đổi giữa các tập tin đang làm việc của bạn và kho lưu trữ trung tâm.
Nếu bạn đã kiến tạo tập tin mới, hoặc đã xóa các tập tin cũ đi, thì bạn cần phải thi hành 'svn add /path/to/file' hoặc 'svn rm /path/to/file' trước khi tạo bản liệt kê sự chênh lệch. Để xem danh sách các tập tin bị ảnh hưởng, xin hãy thi hành lệnh 'svn status'.
Tải diff file lên đây (Upload the diff file here). Nếu bạn chưa có tài khoản thì bạn có thể đăng ký lấy một cái (register for one).
Sau khi gửi bản liệt kê sự khác biệt lên rồi thì bạn sẽ được yêu cầu phải "Create a new Revision" trước khi bạn có thể thêm tiêu đề và miêu tả về các thay đổi của mình.
Xin vui lòng kiểm tra xem Documentation project đã được ấn định trong ô tags hay chưa, vì cái này sẽ nhằm thông báo cho nhóm điều hành biết về việc sửa đổi của bạn. Bạn còn có thể liên lạc (contact) với nhóm điều hành dùng danh sách gửi thư hoặc thông qua Trò Chuyện Trực Tuyến về Blender (Blender Chat) nữa.
Họ sẽ xem xét bản patch của bạn và báo cho bạn biết là có thay đổi nào trong những sửa đổi của bạn cần phải làm lại hay không. Nếu không có vấn đề gì thì bản patch của bạn sẽ được chấp thuận và sẽ được nhóm điều hành commit.
Ghi chú
Nếu bản patch của bạn có bao gồm những thay đổi trong các hình ảnh hoặc có các hình ảnh mới bổ sung vào, thì bạn chỉ cần đính kèm chúng, khi bạn tạo bản hiệu chỉnh mới, thôi nhé.
Các bản liệt kê sửa đổi đơn giản chắc chắn sẽ được chấp nhận rất nhanh. Một khi bạn đã thành thục với việc thực hiện các thay đổi và không cần sự hỗ trợ nữa, thì chúng tôi sẽ cắt bỏ người trung gian và cho phép bạn quyền truy cập trực tiếp để chỉnh sửa bản hướng dẫn sử dụng.
Xem thêm
See Chu Kỳ Phát Hành (Release Cycle) for documentation on how to make commits to a specific release branch and how to create merge commits.
Trực Tiếp Chuyển Giao Sửa Đổi vào Kho Lưu Trữ (Commit Directly)
Khi bạn đã được cung cấp quyền truy cập trực tiếp để biên soạn bản hướng dẫn sử dụng thì bạn có thể khởi công chuyển giao trực tiếp mà không phải tạo tập tin patch như trước nữa. Việc làm này sẽ đưa thay đổi trực tiếp thẳng vào kho lưu trữ trung tâm của chúng tôi.
Bạn chỉ cần thi hành:
svn commit -m "This is what I did"
Nếu bạn không đánh '-m "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.
Đừng bao giờ quên thi hành lệnh cập nhật 'svn update' trước khi chuyển giao các sửa đổi vào kho dự trữ.
Sau đó, bạn sẽ được yêu cầu điền tên người dùng của mình và mật khẩu (từ developer.blender.org) vào, trước khi thay đổi được chuyển giao vào kho để lưu lại.
Ghi chú
Hãy đảm bảo rằng bạn sử dụng tên người dùng của mình (có phân biệt chữ hoa/thường) chứ không phải thư điện tử của bạn đâu nhé.
Các tập tin đã sửa đổi của bạn sẽ được tải lên kho lưu trữ trung tâm để những người khác tiếp tục làm việc và cộng tác. Các chuyển giao về sửa đổi sẽ được lưu trữ và theo dõi trong kho Diffusion. Thay đổi của bạn sẽ được đăng trong bản hướng dẫn sử dụng trực tuyến.
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, với một từ tiền tố như 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.