Code Review Checklist mà Back-End Developer nhất định phải biết
Các Lập trình viên có thể sử dụng checklist này để tham chiếu và tùy chỉnh để phù hợp với nhu cầu cụ thể
1. Kiểu Mã (Code Style)
Xác định rằng mã nguồn tuân theo hướng dẫn về kiểu mã đã được thỏa thuận.
2. Bảo Trì Mã Nguồn
Mã nguồn tuân theo các nguyên tắc của mã sạch (hoặc bất kỳ nguyên tắc nào khác được thỏa thuận).
3. Yêu Cầu
Mã nguồn đáp ứng các yêu cầu cụ thể đã được chỉ định.
Chắc chắn rằng mã nguồn mới không làm hỏng bất kỳ chức năng hiện có nào.
4. Thiết Kế API
Bất kỳ API mới nào cũng phải tuân theo hướng dẫn thiết kế API đã được thỏa thuận.
5. Tài Liệu và Chú Thích
Bất kỳ tài liệu mã nguồn trong hoặc ngoài nào cũng cần thiết được chú thích một cách rõ ràng, tùy thuộc vào quy trình tài liệu đã được thỏa thuận.
6. Xử Lý Lỗi
Chắn chắn rằng lỗi được xử lý đúng cách và thông báo lỗi có ý nghĩa.
7. Bảo Mật
– Đầu vào được xác thực đúng cách.
– Dữ liệu nhạy cảm (mật khẩu, token) được lưu trữ một cách an toàn và không bị rò rỉ vào các nhật ký.
– Kiểm tra mã nguồn để phát hiện các lỗ hổng bảo mật tiềm ẩn, chẳng hạn như tấn công SQL Injection hoặc vấn đề xác thực.
8. Phụ Thuộc
– Các phụ thuộc được cập nhật và không có lỗ hổng bảo mật
– Bất kỳ thay đổi nào gây ra sự phá vỡ khi cập nhật các phụ thuộc.
9. Ghi Log
– Các điểm quan trọng trong mã nguồn được chú thích bởi ghi log hữu ích cho việc gỡ lỗi.
– Việc ghi log tuân theo hướng dẫn ghi log đã được thỏa thuận.
10. Kiểm Tra
Mã nguồn được kiểm soát bởi các loại kiểm thử tự động phù hợp.
11. Hiệu Suất
Đánh giá mã nguồn để phát hiện các vấn đề về hiệu suất (bộ nhớ, CPU, mạng) giúp các truy vấn cơ sở dữ liệu được tối ưu hóa.
12. Quản Lý Phiên Bản
Quy trình và thực hành quản lý phiên bản đã được thỏa thuận được tuân theo.
13. Chính Tả
Đàm bảo các mã nguồn đúng chính tả, điều này làm cho mã nguồn dễ tìm kiếm hơn.
Thông qua Code Review checklist , các back-end Developer có thể đảm bảo các chương trình hoạt động trơn tru, an toàn và có khả năng phát triển trong tương lai. Để trở thành back-end developer với lộ trình bài bản, có người hướng dẫn từng bước đến ra nghề đi làm, tham khảo ngay tại ĐÂY!
