Hướng dẫn dùng AI

Prompt viết thông báo commit rõ thay đổi và lý do

Thông báo commit tốt giúp người đọc lịch sử hiểu thay đổi và lý do mà không mở toàn bộ diff. AI có thể soạn nhanh nếu được cung cấp diff đã staged, quy ước repo và ngữ cảnh issue; nó không nên bịa mã ticket hoặc kết quả test.

Ý chính
  • Một commit, một ý định: diff trộn sửa lỗi với format thì tách trước khi xin message.
  • Tiêu đề nói thay đổi, thân nói lý do: AI không được bịa số issue, kết quả test hay BREAKING CHANGE.
  • Ví dụ xuyên suốt: fix(parser): giữ dấu trừ khi đọc số âm, vì trước đó -3 bị đọc thành 3.

Bắt đầu từ một ví dụ cụ thể

Ví dụ xuyên suốt bài là một diff sửa bộ đọc số: trước đây số âm -3 bị đọc thành 3. Thông báo commit tốt nói đúng thay đổi đó, chẳng hạn fix(parser): giữ dấu trừ khi đọc số âm, rồi giải thích lý do ở phần thân. Nó không được nhắc số issue hay kết quả test mà bạn chưa cung cấp cho AI.

PROMPT COMMIT MESSAGEDIFF- bỏ dấu trừ+ giữ số âmfix(parser): giữ dấu trừSố âm từng bị đổi thành dươngKhông bịa issue/test ✓VÍ DỤ KIỂM ĐƯỢCfix(parser): giữ dấu trừ khi đọc số âm — vì -3 từng thành 3
PROMPT COMMIT MESSAGE DIFF - bỏ dấu trừ + giữ số âm fix(parser): giữ dấu trừ Số âm từng bị đổi thành dương Không bịa issue/test ✓ VÍ DỤ KIỂM ĐƯỢC fix(parser): giữ dấu trừ khi đọc số âm — vì -3 từng thành 3
Hình 1. fix(parser): giữ dấu trừ khi đọc số âm — vì -3 từng thành 3.

Commit kể một ý định

Một commit trộn refactor, format và tính năng khó mô tả. Trước khi xin message, xem diff và tách thay đổi không liên quan. AI có thể giúp nhóm hunk, nhưng bạn quyết định lịch sử. Tiêu đề mơ hồ thường là dấu hiệu phạm vi commit chưa gọn. Nếu chưa quen commit và khu chuẩn bị (staging area) của Git, xem Git và GitHub là gì.

Tiêu đề nói thay đổi

Dùng động từ nhất quán với convention, nêu thành phần và kết quả. Tránh “update code”, “fix bug” hoặc kể tên tệp. Tài liệu git commit khuyên dòng đầu không quá 50 ký tự, tiếp theo là một dòng trống rồi mới tới phần thân; không thêm dấu chấm cuối nếu repo không dùng. Cách soát diff trước khi nhờ AI viết message có trong bài dùng AI với Git. Loại và scope chỉ dùng khi dự án đã chọn quy ước.

Body nói lý do và đánh đổi

Diff cho thấy làm gì nhưng không luôn cho biết vì sao. Cung cấp triệu chứng, quyết định và điều cố ý không làm. Body có thể nêu hành vi trước-sau, migration hoặc rủi ro. Không chép từng dòng code và không quảng cáo chất lượng.

Không bịa metadata

AI không được tự thêm issue, người đồng tác giả, breaking change hoặc test đã chạy. Chỉ dùng thông tin bạn cung cấp hoặc dữ liệu repo nhìn thấy. Nếu thiếu, để placeholder hoặc hỏi. Metadata sai làm hỏng tự động hóa và lịch sử trách nhiệm.

Đối chiếu message với diff

Sau khi soạn, kiểm mọi khẳng định có trong staged diff. Nếu message nói thêm validation nhưng diff chỉ đổi tên, phải sửa. Ngược lại, nếu diff đổi schema mà message không nhắc migration, tiêu đề đang che thay đổi quan trọng.

Commit message không thay review

Một message đẹp không làm code đúng. Chạy test, xem diff và secret trước commit. Không gửi toàn bộ code riêng tư đến công cụ không được duyệt chỉ để lấy một câu tiêu đề; có thể tự tóm tắt diff hoặc dùng công cụ nội bộ.

Bốn prompt mẫu chép dùng ngay

Prompt 1: tóm tắt staged diff

Từ staged diff dưới đây, hãy liệt kê tối đa 5 thay đổi quan sát được và một câu về ý định chung. Không viết commit message, không suy đoán issue, lý do hoặc test. Đánh dấu hunk không cùng ý định và đề xuất cách tách. Quy ước repo: [dán vài commit gần đây]. Diff: [dán diff đã loại bí mật].

Prompt 2: viết tiêu đề commit

Dựa trên diff và ý định đã xác nhận, đề xuất 7 tiêu đề commit theo quy ước [convention], tối đa [số] ký tự. Mỗi tiêu đề dùng động từ cụ thể, nêu thành phần và kết quả; không nhắc tên tệp, không thêm issue. Sau mỗi phương án, giải thích sắc thái trong một câu. [dán tóm tắt đã duyệt].

Prompt 3: viết body giải thích lý do

Viết body commit từ các dữ kiện: hành vi trước [mô tả], vấn đề [mô tả], quyết định [mô tả], hành vi sau [mô tả], giới hạn [mô tả]. Dòng khoảng 72 ký tự nếu phù hợp convention. Không lặp tiêu đề, không bịa benchmark hoặc test. Metadata chỉ dùng danh sách tôi cung cấp.

Prompt 4: kiểm message với diff

Đối chiếu commit message và staged diff. Trả bảng từng khẳng định, hunk chứng minh và trạng thái đúng/thiếu/quá lời. Tìm thay đổi quan trọng trong diff chưa được message nói, đặc biệt API, schema, config và dependency. Đề xuất bản sửa tối thiểu; không thay code. [dán message và diff].

Khi kết quả chưa đúng thì sửa prompt thế nào

Nếu message chung chung, yêu cầu nêu hành vi trước-sau và component. Nếu AI bịa issue hoặc test, cấm metadata không được cung cấp. Nếu tiêu đề dài, tách commit hoặc chuyển lý do xuống body. Nếu không thể tìm một ý định chung, đừng ép một message; dùng Prompt 1 để tách hunk. Nếu convention không rõ, cung cấp năm commit gần đây thay vì nói “theo chuẩn dự án”.

Bài thực hành

Tạo một diff nhỏ sửa lỗi parse số âm và thêm test. Chạy Prompt 1, xác nhận các hunk cùng ý định. Chọn tiêu đề từ Prompt 2 rồi tự viết body trước khi so với Prompt 3. Dùng Prompt 4 để bắt một câu quá lời. Không commit cho tới khi diff và test sạch.

Ca mẫu: một diff nhỏ nhưng chứa hai ý định

Diff vừa sửa parser giữ dấu trừ cho số âm, vừa format toàn bộ tệp. AI có thể viết một tiêu đề nghe hợp lý nhưng lịch sử vẫn khó review vì hàng trăm dòng không liên quan. Trước tiên tách hunk cơ học khỏi hunk hành vi; nếu formatter bắt buộc, đặt nó ở commit riêng hoặc giới hạn phạm vi. Với commit sửa lỗi, bằng chứng trong diff cho phép nói hành vi trước biến -3 thành 3 và hành vi sau giữ dấu. Không được nói “đã sửa issue #42”, “tăng hiệu năng” hoặc “mọi test đều qua” nếu dữ kiện đó không được cung cấp. Tiêu đề dùng động từ và component theo convention của repo; body giải thích lý do khi tiêu đề chưa đủ. Đọc message ngược lại để kiểm mỗi khẳng định có hunk chứng minh, rồi xem diff còn thay đổi API, dependency hoặc cấu hình chưa được nhắc. Message không thay thế review code, nhưng nó là giao diện của lịch sử cho bisect, release note và người điều tra sự cố. Nếu không thể tóm tắt bằng một ý định, giải pháp thường là tách commit chứ không phải viết câu dài hơn. Trước khi chốt, so với năm commit gần nhất để giữ giọng và scope nhất quán. Nếu repo dùng breaking-change footer hoặc mã issue bắt buộc, chỉ thêm metadata đã được người dùng cung cấp. Một message trung thực nhưng ngắn luôn tốt hơn đoạn mô tả dài chứa suy đoán không thể kiểm.

Prompt thứ năm: tự kiểm bằng tình huống của bạn

Đối chiếu staged diff với câu chuyện thay đổi tôi cung cấp. Tách hunk theo ý định và đánh dấu nhóm không nên ở cùng commit. Với nhóm chính, lập bảng khẳng định có thể nói, bằng chứng trong diff và điều chưa biết; tuyệt đối không suy ra issue, test hay benchmark. Viết ba tiêu đề theo convention repo, rồi một body chỉ giải thích hành vi trước, nguyên nhân và hành vi sau có bằng chứng. Cuối cùng đọc ngược message để tìm câu quá lời hoặc thay đổi quan trọng bị bỏ sót, nhất là API, cấu hình, schema và dependency.

Câu hỏi thường gặp

Dòng tiêu đề commit nên dài bao nhiêu?

Không bắt buộc, nhưng tài liệu git commit khuyên tối đa 50 ký tự, vì phần chữ tới dòng trống đầu tiên được Git dùng làm tiêu đề commit ở nhiều nơi.

Có bắt buộc dùng Conventional Commits không?

Không. Đó là một quy ước tùy chọn có dạng loại(phạm vi): mô tả, ví dụ fix(parser): ...; chỉ dùng khi dự án đã chọn nó.

AI có được tự thêm số issue hay BREAKING CHANGE không?

Không, trừ khi bạn cung cấp. Theo Conventional Commits, footer BREAKING CHANGE: báo một thay đổi phá vỡ API, ứng với tăng số phiên bản chính (MAJOR), nên thêm nhầm sẽ làm công cụ phát hành hiểu sai.

Học tiếp

Muốn học bài bản cùng giảng viên?

Khóa AI – Introduction to Machine Learning: nền tảng Máy học từ thuật toán cơ bản đến Neural Networks và LLM, học bằng Python. Học thử buổi 1 miễn phí.

Xem Khóa AI

Nguồn tham khảo

Chia sẻ: Facebook LinkedIn
Nhắn Zalo tư vấnZalo Gọi 0937 401 483