Chọn dự án công khai và tuyên bố cần kiểm chứng
Bắt đầu với một kho công khai cụ thể thuộc dự án của bạn hoặc một tổ chức bạn đang nghiên cứu. Sao chép đầy đủ tên owner và repository. Viết chính xác câu tuyên bố về tính năng bạn cần tìm, đồng thời phân biệt tài liệu với kết quả kiểm thử của phần triển khai.
Dùng quy trình này để tìm tài liệu dự án. Không tìm kiếm thông tin đăng nhập bị lộ, thông tin liên hệ riêng tư hoặc cách vượt qua kiểm soát truy cập kho.
Dùng bộ lọc tìm kiếm mã một cách có chủ đích
Tài liệu tìm kiếm mã của GitHub giải thích rằng một thuật ngữ trần có thể khớp với đường dẫn tệp hoặc nội dung tệp. repo: giới hạn tìm kiếm trong tên đầy đủ owner/repository, path: thu hẹp đường dẫn và content: yêu cầu thuật ngữ phải có trong nội dung tệp. Chuỗi trong dấu ngoặc kép có thể tìm cụm từ chính xác. Các quy tắc này áp dụng cho tìm kiếm mã, không tự động áp dụng cho tìm kiếm issue hay hồ sơ. Nguồn
Với một kho minh họa tên example-owner/example-project, truy vấn có thể là:
repo:example-owner/example-project content:"export format"Tên và cụm từ trên chỉ là ví dụ, không phải một lần tìm kiếm thực tế chúng tôi đã thực hiện. Hãy thay bằng kho bạn được phép xem xét và cách diễn đạt phù hợp với câu hỏi của bạn. Nếu biết các tệp nằm trong thư mục tài liệu, hãy thêm giới hạn path: phù hợp; nếu không, đừng đưa giả định đó vào.
Diễn giải kết quả khớp trước khi trích dẫn
| Kết quả | Cần kiểm tra gì | Không chứng minh điều gì |
|---|---|---|
| Tên tệp khớp | Cụm từ có xuất hiện trong nội dung hay không | Tệp hỗ trợ cho tuyên bố |
| Đoạn tài liệu | Phiên bản và điều kiện áp dụng của tính năng gần đó | Tính năng được mô tả đã được kiểm thử |
| Ví dụ hoặc đề xuất | Nội dung mô tả hành vi dự kiến hay minh họa | Chức năng đã được phát hành |
| Kết quả rỗng | Repository, loại truy vấn và các giới hạn | Tuyên bố chưa từng tồn tại ở bất kỳ đâu |
GitHub ghi nhận yêu cầu đăng nhập đối với tìm kiếm mã trên toàn bộ kho công khai. Tài liệu cũng phân biệt trang web GitHub Pages với nội dung mã nguồn trong kho. Nguồn Hãy ghi lại phạm vi tìm kiếm thực tế và các giới hạn truy cập; không vượt qua yêu cầu đăng nhập và không coi một trang web chưa được tìm kiếm là đã được bao phủ.
Gắn đoạn trích với một phiên bản
Mở tệp và đọc toàn bộ phần liên quan. Ghi nhận tuyên bố trong tài liệu là của dự án. Không chạy mã trong kho chỉ để hoàn thành việc đọc này, và không suy ra độ tin cậy của sản phẩm từ số sao hay tên tài khoản.
Khi đã xác định đúng đoạn trích, hãy làm theo hướng dẫn tạo liên kết cố định GitHub để lưu lại phiên bản đã xem xét. Sau đó, danh sách kiểm tra nguồn cho AI giúp tách câu tuyên bố trong tài liệu khỏi những kết luận do mô hình thêm vào.