Lộ trình 02Bài học 2 / 6

Cung cấp ngữ cảnh repository hữu ích cho agent

Cung cấp hướng dẫn hiện hành, mã liên quan và lệnh kiểm tra chạy được mà không làm lộ thông tin không cần thiết.

Thực hành9 minĐã review

Xuất bản bởi Cách chúng tôi viết

Kiểm tra mức hiểuHướng dẫn repository khuyến nghị một lệnh không còn tồn tại. Agent nên làm gì?Làm bài tập
Hướng dẫn repository khuyến nghị một lệnh không còn tồn tại. Agent nên làm gì?

Bạn sẽ học gì

  • Chuẩn bị bộ ngữ cảnh có trọng tâm cho tác vụ trong repository.
  • Nhận diện hướng dẫn lỗi thời hoặc mâu thuẫn.
  • Giữ thông tin xác thực và dữ liệu riêng tư không liên quan ngoài ngữ cảnh tác vụ.

Bắt đầu từ checkout hiện tại

Agent cần biết repository và branch nó đang thay đổi. Nó cũng cần biết thư mục làm việc có thay đổi không liên quan không. Những thông tin này ảnh hưởng đến việc có thể sửa gì an toàn và cách hiểu diff cuối cùng.

Yêu cầu agent kiểm tra hướng dẫn dự án và cấu hình package trước khi viết mã. Lệnh nhớ từ repository khác có thể sai ở đây. Tên framework quen thuộc không xác định phiên bản đã cài hay quy ước dự án.

Với thay đổi nhỏ, cung cấp module liên quan, phần mã gọi, test và quyết định kiến trúc. Bổ sung thông tin khi điều tra cho thấy nhu cầu cụ thể.

Dùng hướng dẫn repository cho quy tắc ổn định

Tệp hướng dẫn có thể mô tả lệnh được hỗ trợ, ranh giới module, yêu cầu review và hành động cần người phụ trách quyết định. Quy ước AGENTS.md cung cấp vị trí dễ nhận biết để công cụ lập trình tìm thông tin này. Mức hỗ trợ và thứ tự ưu tiên hướng dẫn có thể khác nhau, nên hãy kiểm tra hành vi công cụ.

Giữ quy tắc dự án ổn định trong repository. Giữ tác vụ hiện tại trong bản mô tả tác vụ. Không biến tệp hướng dẫn thành lịch sử mọi cuộc hội thoại hoặc danh sách kế hoạch tạm thời.

Hướng dẫn hữu ích là “Chạy integration test phân quyền khi route thay đổi hành vi truy cập.” Hướng dẫn mơ hồ là “Luôn cẩn thận với bảo mật.” Câu đầu xác định điều kiện kích hoạt và hành động người review có thể xác minh.

Đối chiếu hướng dẫn với mã

Hướng dẫn lỗi thời khi lệnh, thư mục hoặc kiến trúc thay đổi. Nếu hướng dẫn nêu script không tồn tại, kiểm tra cấu hình package. Nếu tài liệu nói dịch vụ chỉ đọc, kiểm tra quyền trước khi dựa vào nhận định đó.

Ghi lại mâu thuẫn. Dùng bằng chứng trực tiếp về phiên bản hiện tại để hiểu hành vi thực tế của mã. Không âm thầm bỏ chính sách có chủ ý vì mã cũ vi phạm nó. Chính sách và hành vi hiện tại trả lời hai câu hỏi khác nhau.

Ví dụ, hướng dẫn có thể cấm ghi trực tiếp vào branch dùng chung trong khi script cũ vẫn làm vậy. Cách xử lý đúng là giữ chính sách và sửa script. Mã hiện có không cho phép lặp lại hành động bị cấm.

Giữ ngữ cảnh liên quan và an toàn

Toàn bộ repository có thể chứa thông tin xác thực, fixture riêng tư, dữ liệu xuất của khách hàng và log hỗ trợ cũ. Quyền truy cập repository không tự động làm mọi tệp phù hợp để gửi tới dịch vụ mô hình.

Dùng công cụ đã phê duyệt và quy tắc xử lý dữ liệu. Loại secret khỏi ngữ cảnh. Thay ví dụ khách hàng bằng dữ liệu giả định khi có thể. Kiểm tra cả công cụ kết nối lẫn tệp tải lên: connector tìm kiếm có thể truy xuất thông tin chưa từng có trong prompt ban đầu.

Hướng dẫn repository “không đọc secret” là chỉ dẫn hữu ích. Nó không thay thế việc hạn chế truy cập kho secret và thư mục nhạy cảm.

Để lại hồ sơ hữu ích cho người tiếp theo

Khi hoàn tất, ghi hành vi đã thay đổi, xác minh và giới hạn chưa giải quyết trong pull request. Cập nhật tài liệu dự án dùng lâu dài khi quy trình được hỗ trợ thay đổi. Tránh chép toàn bộ hội thoại agent vào repository.

Hồ sơ cần giúp người bảo trì sau này lặp lại công việc mà không dựng lại cuộc hội thoại dài. Liên kết tài liệu chuẩn và giữ một mô tả có thẩm quyền cho mỗi quy tắc ổn định.

Ngữ cảnh tốt giảm điều tra lặp lại. Nó cũng giúp phát hiện lỗi dễ hơn vì hành vi mong đợi và lệnh chạy được đã rõ ràng.

Làm bài tập

Kiểm tra một tệp hướng dẫn repository. Xác minh ba lệnh với dự án hiện tại. Tìm một nhận định lỗi thời hoặc ràng buộc còn thiếu. Đề xuất sửa nhỏ qua quy trình review thông thường. Không đưa vào thông tin xác thực hoặc dữ liệu khách hàng.

Tải worksheet (Markdown)
Kiểm tra mức hiểu ↑

Tiếp tục học

Nguồn và đọc thêm

Đọc thêm liên quan từ Taiga

← Bài trước: Viết bản mô tả tác vụ cho agent