Chuyển tới nội dung chính
All cases

Đánh giá mã nguồn và Pull Request

Đánh giá mã nguồn và Pull Request

Tags: Code review | Commit review | Quality | Risk assessment

1. Mục đích​

Sử dụng quy trình này trước khi merge một commit hoặc Pull Request. CodeVista sẽ đọc diff và ngữ cảnh repository xung quanh, tóm tắt các thay đổi, đồng thời báo cáo các lỗi tiềm ẩn, thiếu sót trong xác thực dữ liệu, xử lý lỗi yếu, các vấn đề về khả năng bảo trì và các trường hợp thiếu kiểm thử (test gaps).

2. Trước khi bắt đầu​

  • Mở repository chứa commit cần đánh giá trong workspace CodeVista hiện tại.
  • Xác nhận rằng commit đó đã tồn tại ở local và lấy mã hash của commit.
  • Xác nhận rằng Slash Command /review khả dụng trong phiên bản CodeVista đang sử dụng.

3. Lời nhắc khởi động (Starter Prompt)​

/review this commit <commit-hash>

Ví dụ thực tế​

/review this commit 2f6865474719010a1b2f2997c6e79784a1fa9728

4. Cách sử dụng​

  1. Sao chép mã hash của commit bạn muốn đánh giá.
  2. Mở repository và khung chat CodeVista.
  3. Chạy lệnh review kèm theo commit hash.
  4. Đối chiếu từng phát hiện với file, symbol và ngữ cảnh repository được dẫn chứng.
  5. Yêu cầu bản sửa lỗi tập trung, bổ sung bài test hoặc tóm tắt Pull Request khi cần thiết.

5. Kết quả mong đợi​

  • Tóm tắt thay đổi: Mục đích và các hành vi bị ảnh hưởng của commit được giải thích súc tích.
  • Phát hiện theo mức độ ưu tiên: Các vấn đề được phân nhóm theo mức độ nghiêm trọng và gắn liền với file hoặc symbol liên quan.
  • Khuyến nghị hành động: Mỗi vấn đề được xác nhận đều nêu rõ tác động và bước khắc phục thực tế tiếp theo.

Minh họa đánh giá code và Pull Request

6. Mẹo hữu ích​

  • Tách bạch giữa các lỗi thực tế đã được xác nhận với các đề xuất cải tiến hoặc sở thích phong cách viết code.
  • Yêu cầu mỗi phát hiện phải bao gồm đủ: mức độ nghiêm trọng, bằng chứng, tác động và khuyến nghị xử lý.
  • Yêu cầu CodeVista chỉ ra cụ thể các khoảng trống kiểm thử liên quan trực tiếp đến hành vi vừa thay đổi.