Chuẩn bị nội dung pull request hữu ích | DevPrompt Lab
Trình bày rõ mục đích, rủi ro, xác minh và điểm cần người rà soát chú ý.
workflow · Code review · beginner
English Tiếng ViệtQuy trình ngắn để soạn mô tả pull request trung thực, dựa trên diff và kết quả kiểm tra thực tế.
Nội dung có thể tái sử dụng
Đọc toàn bộ diff và bối cảnh repository. Soạn mô tả pull request gồm: mục đích, hành vi hiển thị với người dùng, tóm tắt triển khai, ảnh hưởng tới dữ liệu hoặc tương thích URL, cân nhắc bảo mật, kiểm thử đã thực hiện kèm kết quả chính xác và giới hạn đã biết. Xác định hai hoặc ba phần người rà soát nên chú ý nhất. Không khẳng định kiểm thử đạt nếu chưa chạy và chưa đạt. Viết sao cho đồng đội chưa biết yêu cầu vẫn hiểu được.
Diff: {{DIFF}}
Bối cảnh: {{CONTEXT}}
Các bước đã kiểm tra: {{CHECKS}}
Cách sử dụng
Dùng diff cuối cùng và đầu ra lệnh thật. Xóa bí mật nội bộ trước khi chia sẻ.
Ví dụ
Xác minh: `npm run lint` đạt; kiểm tra cú pháp PHP đạt. Chưa chạy kiểm thử migration vì chưa có cơ sở dữ liệu kiểm thử cô lập.