Tái cấu trúc và giữ nguyên hợp đồng | DevPrompt Lab

Mẫu tái cấu trúc an toàn, yêu cầu kiểm kê hợp đồng trước và giữ từng thay đổi dễ rà soát.

Nội dung có thể tái sử dụng

Hãy tái cấu trúc mô-đun được nêu để giải quyết vấn đề bảo trì. Trước khi sửa, xác định API công khai, cấu trúc dữ liệu tuần tự hóa, route, hành vi cơ sở dữ liệu và các nơi gọi cần tương thích. Ưu tiên thay đổi nhỏ, mỗi thay đổi có một mục đích rõ ràng. Giữ quy tắc nghiệp vụ ngoài mã giao diện và tránh viết lại trên diện rộng. Bổ sung hoặc cập nhật kiểm thử tập trung cho hành vi cần giữ. Sau khi sửa, tóm tắt tệp đã đổi, ảnh hưởng tương thích và các bước kiểm tra thực sự đã chạy. Nếu mục tiêu đòi hỏi thay đổi phá vỡ tương thích, hãy dừng lại và giải thích lựa chọn.

Mô-đun: {{MODULE}}

Vấn đề bảo trì: {{PAIN_POINT}}

Hợp đồng cần giữ: {{CONTRACTS}}

Lệnh kiểm thử: {{TEST_COMMAND}}

Cách sử dụng

Cung cấp hợp đồng được hỗ trợ và phạm vi mô-đun hẹp. Không đưa định dạng lại không liên quan vào diff.

Ví dụ

Được giữ: POST /api/v1/user/projects vẫn trả cùng cấu trúc phản hồi. Thay đổi: tách kiểm tra dữ liệu sang hàm domain.