Drama Công TyChính thứcHôm qua
Code review: cách viết comment để PR được sửa nhanh mà không ai tự ái
Một comment "sai rồi" có thể khiến PR nằm đó ba ngày. Một comment rõ ràng giúp người viết sửa trong mười phút. Khác biệt thường nằm ở cách viết, không phải ở kiến thức.
Khi review
- Nói rõ mức độ: đánh dấu "chặn merge", "nên sửa", hay "gợi ý, tuỳ bạn". Nhiều team dùng tiền tố như
blocking:,nit:,question:. - Giải thích vì sao, không chỉ cái gì: "Hàm này gọi API trong vòng lặp, 100 item là 100 request" hữu ích hơn "đừng làm vậy".
- Hỏi khi không chắc: "Mình hiểu là case rỗng sẽ trả null, đúng không?" mở được cuộc nói chuyện mà không đổ lỗi.
- Nói về code, không nói về người: "đoạn này khó đọc" thay vì "bạn viết khó đọc".
- Khen chỗ đáng khen. Một dòng "cách tách hàm này gọn quá" không tốn gì.
- Vấn đề lớn về hướng thiết kế: nói chuyện trực tiếp hoặc gọi ngắn, đừng để 30 comment qua lại.
Khi gửi PR
- PR nhỏ, một mục đích. 200 dòng được review kỹ; 2.000 dòng thường chỉ được "LGTM".
- Mô tả: làm gì, vì sao, đã test thế nào, chỗ nào muốn người review nhìn kỹ.
- Tự review diff một lượt trước khi gửi: bạn sẽ tự bắt được một nửa số lỗi.
Comment review nào bạn nhớ nhất, theo nghĩa tốt hay xấu? Và team bạn có quy ước gì hay không?
0 bình luận
Chưa có bình luận nào. Bạn mở lời trước nhé.