Nhận đánh giá yêu cầu kéo¶
Yêu cầu pull của bạn đã được gửi và đã vượt qua kiểm tra CI. Hiện tại, yêu cầu này đã sẵn sàng để được xem xét.
tl;dr - Quy trình đánh giá¶
Tóm tắt quy trình đánh giá:
- Hãy chờ kết quả đánh giá.
- Trả lời phản hồi.
- Nếu có yêu cầu thay đổi:
- Tiến hành thực hiện các thay đổi theo yêu cầu.
- Gửi tất cả các thay đổi được yêu cầu.
- Hãy gửi lại yêu cầu xem xét khi tất cả các thay đổi được yêu cầu đã được gửi đi.
- Lặp lại phần ba cho đến khi không cần thực hiện thêm bất kỳ thay đổi nào nữa.
- Hãy đợi cho đến khi yêu cầu kéo của bạn được chấp thuận và hợp nhất.
Xin chúc mừng! Bạn vừa đóng góp cho BeeWare Docs Tools!
Tôi đã gửi yêu cầu pull, bước tiếp theo là gì?¶
Sau khi gửi yêu cầu pull, bạn sẽ cần chờ đợi để đóng góp của mình được xem xét. Quá trình xem xét bao gồm hai khía cạnh: thực hiện việc xem xét và nhận được phản hồi về việc xem xét.
Xem xét các kỳ vọng
Bạn nên mong đợi rằng bất kỳ ai đánh giá các bài đóng góp của bạn đều tuân thủ các hướng dẫn này, bao gồm cả các đánh giá từ các thành viên trong nhóm nòng cốt. Bạn cũng nên tuân thủ các hướng dẫn này khi đánh giá các bài đóng góp của người khác.
Nếu bạn cảm thấy người đánh giá của mình đang đi chệch khỏi những kỳ vọng này và bạn cảm thấy thoải mái khi tự mình nêu vấn đề trong yêu cầu pull, bạn có thể làm như vậy. Nếu bạn không cảm thấy thoải mái, vui lòng liên hệ với Nhóm Phản hồi Quy tắc Ứng xử BeeWare. Chúng tôi sẽ xem xét báo cáo của bạn và liên hệ với người đánh giá của bạn. Việc theo dõi sẽ phản ánh hành động được báo cáo; một vi phạm nhỏ có thể dẫn đến một cuộc thảo luận, trong khi một vi phạm nghiêm trọng có thể dẫn đến hậu quả nghiêm trọng hơn.
Viết đánh giá¶
Mọi người đều được hoan nghênh đóng góp ý kiến đánh giá cho bất kỳ yêu cầu kéo (pull request) nào. Các hướng dẫn này nêu rõ những kỳ vọng của chúng tôi đối với một bài đánh giá, bất kể bài đánh giá đó được thực hiện bởi thành viên nhóm nòng cốt hay thành viên cộng đồng.
Một thành viên trong nhóm nòng cốt luôn phải thực hiện bước đánh giá cuối cùng; tuy nhiên, các đánh giá từ thành viên cộng đồng có thể là một cách hữu ích để tối ưu hóa quy trình — lý tưởng nhất là việc đánh giá của nhóm nòng cốt chỉ còn là thủ tục hình thức sau khi các đánh giá từ cộng đồng đã chỉ ra tất cả các vấn đề chính.
Nhận được đánh giá¶
Quá trình nhận đánh giá bao gồm ba bước cơ bản:
- Những phản hồi và câu hỏi ban đầu.
- Yêu cầu thay đổi.
- Phê duyệt và hợp nhất.
Mỗi bước được hướng dẫn chi tiết dưới đây. Nếu trong quá trình thực hiện, bạn có bất kỳ thắc mắc nào, đừng ngần ngại hỏi nhé! Chúng tôi rất sẵn lòng hỗ trợ bạn.
Lịch trình và phản hồi ban đầu¶
Nhóm nòng cốt đặt mục tiêu đảm bảo mọi yêu cầu pull sẽ được xem xét trong vòng mười ngày làm việc. Tuy nhiên, đối với các bản gửi phức tạp hơn, hoặc khi yêu cầu pull được gửi trong thời gian một số thành viên trong nhóm đang nghỉ phép, thời hạn này có thể được kéo dài.
Chúng tôi thường duy trì sự liên tục trong việc phân công người đánh giá cho từng yêu cầu kéo (pull request) – tức là bạn có thể sẽ làm việc với cùng một người đánh giá trong suốt quá trình đánh giá. Điều này có nghĩa là người đánh giá của bạn sẽ nắm rõ bối cảnh trong suốt quá trình, và bạn sẽ biết được tần suất phản hồi cũng như phong cách đánh giá của họ. Nếu người đánh giá ban đầu nhận thấy rằng họ không có chuyên môn cần thiết để đánh giá pull request của bạn, hoặc họ biết rằng họ sẽ không thể tham gia vì lý do nào đó, họ có thể chuyển trách nhiệm đánh giá pull request của bạn cho một thành viên khác trong nhóm.
Quý vị có thể mong đợi chúng tôi sẽ phản hồi từng trao đổi trong vòng mười ngày làm việc liên tục. Việc trả lời các ý kiến phản hồi và câu hỏi là một phần quan trọng của quy trình đánh giá. Chúng tôi mong nhận được phản hồi từ quý vị trước khi chuyển sang bước tiếp theo trong quy trình.
Yêu cầu thay đổi¶
Hầu hết các trường hợp, người đánh giá sẽ yêu cầu bạn điều chỉnh pull request của mình. Điều này không hẳn là do chất lượng công việc của bạn, mà chỉ đơn giản là một phần của quy trình.
Nếu đợt đánh giá ban đầu phát hiện ra một số lượng đáng kể các vấn đề, đợt đánh giá đầu tiên có thể sẽ không mang tính toàn diện. Thay vào đó, đợt đánh giá này sẽ tập trung vào việc đưa ra những hướng dẫn tổng quát về công việc cần thực hiện để đưa yêu cầu hợp nhất (pull request) vào trạng thái có thể hợp nhất được. Quá trình đánh giá có thể bao gồm các câu hỏi nhằm làm rõ mục đích và phạm vi của công việc đã được thực hiện.
Thực hiện các thay đổi theo yêu cầu¶
Người đánh giá sẽ để lại bình luận cho yêu cầu pull của bạn. Những bình luận này có thể mang tính tổng quát, liên quan đến một tệp cụ thể, hoặc liên quan đến một hoặc một số dòng mã cụ thể. Đôi khi, chúng sẽ bao gồm các đề xuất thay đổi cụ thể mà bạn có thể áp dụng trực tiếp cho yêu cầu pull của mình thông qua giao diện người dùng GitHub. Thông thường, đó sẽ là các câu hỏi, yêu cầu làm rõ hoặc hướng dẫn về việc cập nhật.
Đánh dấu cuộc trò chuyện là đã giải quyết
Trong phần thảo luận của quy trình phản hồi, bạn tuyệt đối không nên đánh dấu cuộc trò chuyện do người đánh giá khởi xướng là "đã giải quyết". Việc đánh dấu cuộc trò chuyện là "đã giải quyết" là trách nhiệm của người đánh giá. Việc xác định xem vấn đề đã được phát hiện có được giải quyết hay không là do họ quyết định.
Nếu quá trình đánh giá phát hiện ra một vấn đề mang tính hệ thống (ví dụ: sự không nhất quán trong cách đặt tên trong mã nguồn), người đánh giá có thể sẽ không chỉ ra từng trường hợp cụ thể của vấn đề đó. Thay vào đó, họ có thể chọn một vài ví dụ minh họa cho vấn đề và lưu ý rằng các trường hợp khác cũng cần được sửa chữa. Nếu quá trình đánh giá chỉ ra một vấn đề ở một vị trí nào đó, và bạn cho rằng vấn đề đó có thể xuất hiện ở những nơi khác, bạn nên khắc phục vấn đề đó ở mọi vị trí mà nó xuất hiện. Nếu bạn không chắc chắn, hãy yêu cầu người đánh giá giải thích rõ hơn.
Gửi tất cả các thay đổi được yêu cầu¶
Sau khi đã hoàn tất tất cả các thay đổi được yêu cầu, bạn có thể gửi bản cập nhật cho yêu cầu pull của mình. Thao tác này sẽ kích hoạt một chu trình CI mới; sau khi xác nhận rằng CI vẫn thành công, hãy để lại bình luận yêu cầu đánh giá lại và nhóm nòng cốt sẽ xem xét lại yêu cầu pull của bạn.
Hãy đẩy (push), đừng ép buộc hay thực hiện rebase
Khi bạn cập nhật yêu cầu kéo (pull request) trong quá trình đánh giá, điều quan trọng là phải giữ nguyên lịch sử cam kết. Dù danh sách cam kết có dài đến đâu cũng không thành vấn đề; tất cả chúng sẽ được gộp lại khi chúng ta hợp nhất yêu cầu kéo. Nếu bạn thực hiện lệnh force push hoặc rebase yêu cầu kéo của mình ngay giữa quá trình đánh giá, bạn có thể vô tình loại bỏ bối cảnh quan trọng mà người đánh giá cần.
Yêu cầu xem xét lại¶
Khi bạn đã khắc phục xong tất cả các thay đổi được yêu cầu trong đợt đánh giá đó và hệ thống CI đã chạy thành công trở lại, bạn có thể gửi yêu cầu đánh giá lại cho người đánh giá. Nếu một vấn đề đặc biệt phức tạp và việc khắc phục nó sẽ ảnh hưởng đến một phần khác, bạn có thể yêu cầu đánh giá riêng cho phần cụ thể mà bạn đã cập nhật. Theo quy định, bất kỳ yêu cầu đánh giá nào cũng được coi là yêu cầu đánh giá toàn bộ. Nếu bạn chưa sẵn sàng cho một lần đánh giá toàn diện, hãy đảm bảo nêu rõ chính xác những gì bạn mong muốn.
Phê duyệt và hợp nhất yêu cầu kéo¶
Sau khi bạn đã xử lý xong tất cả các yêu cầu thay đổi, yêu cầu kéo (pull request) sẽ được phê duyệt. Trong hầu hết các trường hợp, ngay sau khi yêu cầu kéo được phê duyệt, chúng tôi sẽ tiến hành hợp nhất ngay lập tức. Tuy nhiên, trong một số trường hợp, có thể có những tình huống đặc biệt, chẳng hạn như việc phải phụ thuộc vào một yêu cầu kéo khác chưa được hợp nhất, dẫn đến sự chậm trễ. Chúng tôi sẽ thông báo điều này trong phần bình luận để bạn nắm rõ tình hình.