Những lưu ý khi Review Code

Những lưu ý khi Review Code
Review code là công việc sẽ diễn ra ngay sau khi những thao tác kiểm tra tự động đã được thực hiện thành công, nhưng trước khi merge vào nhánh làm việc chính.

Mục đích chính

Khi Review Code, bạn không ngừng đặt những câu hỏi như "Liệu mã này có đúng như ý tưởng của tác giả hay không?" hoặc "Mã được dùng để hoàn thành mục đích này có chính xác chưa?"

Ngoài ra nên nhớ rằng,  Function và class nên tồn tại bởi một lý do nhất định. Vì nếu nó không rõ ràng, đây có thể là một dấu hiệu cho thấy code đang xảy ra vấn đề, cần phải chỉnh sửa hay bổ sung thêm comment hoặc test.

Những lưu ý khi Review Code

Quy trình thực hiện

Hãy tập trung vào hướng giải quyết vấn đề, sau đó tìm điểm khác biệt, đồng thời xác định những trường hợp khác nhau của mã như chiều dài và chức năng.

Nếu xuất hiện những chỗ cần trừu tượng hóa thì có thể tái sử dụng trong nhiều bối cảnh khác nhau.

Đồng thời, hãy suy nghĩ thêm về các thư viện hoặc code sẵn có. Bởi vì, mỗi khi ai đó tái thực hiện chức năng đó, có thể họ không biết nó đã từng tồn tại hoặc bị sao chép. Đối với trường hợp này, người Review Code cần xác định lại mục đích cũng như nhắc nhở về việc chức năng và thư viện tương tự  đã được xử lý rồi.

Đặc biệt, mọi thay đổi hay chỉnh sửa đều phải chấp hành những pattern mà toàn nhóm đã thống nhất.

Ngoài ra, một phần của sự thay đổi còn phụ thuộc vào thời gian biên dịch. Do, đa phần các Developer đều muốn giữ các sản phẩm ở dạng liên kết "hờ" và lỏng lẻo.

Những lưu ý khi Review Code

Tính dễ đọc và phong cách sử dụng

Dựa vào vốn kiến thức của chính mình, suy xét về thời gian nắm bắt các khái niệm. Là tên biến và phương thức tiện cho việc theo dõi? Hay việc đặt tên đã nhất quán chưa?

Kiểm tra quy định coding guidelines và coding style của toàn thành phẩm.  Đặc biệt, nó có phù hợp với dự án về style, API conventions hay không? 

Bên cạnh đó, hãy kiểm tra TODO của code, vì nó sẽ chồng chất code và trở nên cũ kĩ theo thời gian. Hãy yêu cầu Developer phụ trách gửi một ticket các vấn đề về GitHub hoặc JIRA và đính kèm số vấn đề vào TODO.

Những lưu ý khi Review Code

Bảo mật

Hãy chắc chắn là những thông tin như API endpoint, token trùng khớp với bên thứ ba hoặc các cấu hình đặc biệt ... không xuất hiện trong PR.

Bình luận

Hãy đánh giá một cách súc tích, khách quan. Đồng thời, chỉ nên phê bình code, chứ không đụng đến tác giả. Hoặc thắc mắc bất kỳ vấn đề nào, hãy hỏi trực tiếp coder.

Nên tránh những đại từ sở hữu, đặc biệt là kết hợp với nhiều đánh giá độc đoán.

Hãy cố gắng làm rõ cũng như phân biệt giữa các đề xuất, thay đổi bắt buộc và những điểm cần thảo luận để xác minh.

Những lưu ý khi Review Code