Quy trình làm việc để xem xét mã dựa trên GitHub

Question

Tôi đang xem xét sử dụng GitHub làm công cụ chính để thực hiện xem xét mã. Với các tính năng như bình luận trực tuyến và so sánh chế độ xem, có vẻ như có rất nhiều tính năng mà các công cụ như Gerrit cung cấp.

Có ai khác đã sử dụng GitHub cho việc này không? Nếu vậy, quy trình làm việc của bạn là gì? Và những gì có kinh nghiệm của bạn đã làm như vậy, cả tích cực và tiêu cực?

Khi tôi nhận được một số suy nghĩ về điều này và sắp xếp những gì sẽ làm việc tốt nhất cho chúng tôi, tôi sẽ chỉnh sửa câu hỏi của mình để chia sẻ quy trình làm việc được đề xuất của riêng tôi.

EDITED với đề xuất quy trình làm việc

Bước 0. Set up a post-receive hook sử dụng tuyệt vời reviewth.is.

Sau đó:

1. Commit như thường lệ với commit -a -s, nhưng trong thông điệp cam kết gắn #reviewthis @username.

2. Nếu bản dựng không thành công, đánh giá sẽ bị bỏ qua cho đến khi bản dựng được khôi phục.

3. Nhận xét của người đánh giá về cam kết từng dòng hoặc ở cấp tệp.

4. GitHub tự động thông báo cho người đánh giá nhận xét.

5. Người đánh giá thông báo cho người nhận xét qua email khi nhận xét hoàn tất với tóm tắt đánh giá.

6. Trả lời đánh giá cho người nhận xét trong GitHub, cho phép truy cập dự án vào lịch sử đánh giá mã.

Vấn đề lớn nhất của tôi là với Bước 2 và bước 4/5. Gerrit hoạt động độc đáo vì không yêu cầu đánh giá trừ khi xây dựng thành công; Tôi muốn một cách để làm điều này trong GitHub. Các bước 4/5 cũng có khả năng gây phiền nhiễu (nhiều email) và giảm tính chất tự động của quá trình xem xét (yêu cầu một bản tóm tắt được gửi qua email).

Chúng tôi sử dụng Hudson làm máy chủ xây dựng của chúng tôi, nếu điều đó có ích.

Bất kỳ suy nghĩ nào về những vấn đề này cũng sẽ hữu ích.

Answer 1

Tôi đã sử dụng nó cho việc này. Luồng công việc tôi đã sử dụng là thực hiện công việc của bạn trên một nhánh chủ đề và gửi yêu cầu kéo trên nhánh đó. (Các) người đánh giá kiểm tra mã và các cam kết, bằng cách sử dụng các nhận xét bằng dòng (và theo cam kết). Các coder có phản hồi đó và thực hiện một rebase phá hoại trên nhánh chủ đề đó, tái đẩy nó (viết lại lịch sử trên repo github của mình), sau đó chu kỳ xem xét lặp lại cho đến khi nó được chấp nhận để hợp nhất.

Chỉnh sửa: Một Githubber đăng trên blog của mình mô tả phương pháp họ sử dụng để phát triển github, và nó khá giống với những gì tôi đề xuất. link

Cập nhật: Tôi hiện đang sử dụng quy trình làm việc này cả trong các dự án mã nguồn mở của tôi và trong công việc chuyên môn của tôi nó vẫn tuyệt vời.

Answer 2

Tại công việc của mình, chúng tôi thực hiện theo quy trình được mô tả tại "Using pull requests" để xem xét mã và chúng tôi rất hài lòng với quy trình này.