เลือกโครงการสาธารณะและข้อกล่าวอ้าง
เริ่มจากคลังสาธารณะที่เฉพาะเจาะจงสำหรับโครงการของคุณเองหรือองค์กรที่คุณกำลังค้นคว้า คัดลอกชื่อ owner และ repository แบบเต็ม เขียนคำแถลงคุณสมบัติที่คุณต้องการค้นหาให้ชัดเจน และแยกแยะระหว่างเอกสารประกอบกับการทดสอบการใช้งานจริง
ใช้ขั้นตอนนี้เพื่อค้นหาเอกสารประกอบโครงการ อย่าค้นหาข้อมูลรับรองที่เปิดเผย ข้อมูลติดต่อส่วนตัว หรือช่องทางหลีกเลี่ยงการควบคุมการเข้าถึงคลัง
ใช้ตัวกรองการค้นหาโค้ดอย่างตั้งใจ
เอกสารการค้นหาโค้ดของ GitHub อธิบายว่าคำเดี่ยวอาจตรงกับเส้นทางไฟล์หรือเนื้อหาของไฟล์ก็ได้ repo: จำกัดการค้นหาให้อยู่ในชื่อ owner/repository แบบเต็ม path: จำกัดเส้นทาง และ content: กำหนดให้คำนั้นต้องอยู่ในเนื้อหาไฟล์ สตริงที่อยู่ในเครื่องหมายคำพูดสามารถค้นหาข้อความที่ตรงกันทุกตัวอักษร กฎเหล่านี้ใช้กับการค้นหาโค้ด ไม่ได้ใช้กับการค้นหา issues หรือโปรไฟล์โดยอัตโนมัติ แหล่งที่มา
สำหรับคลังตัวอย่างที่ชื่อ example-owner/example-project คำค้นอาจเป็น:
repo:example-owner/example-project content:"export format"ชื่อและวลีเหล่านี้เป็นเพียงตัวอย่าง ไม่ใช่การค้นหาจริงที่เราได้ดำเนินการ ให้แทนที่ด้วยคลังที่คุณได้รับอนุญาตให้ตรวจสอบและถ้อยคำที่เกี่ยวข้องกับคำถามของคุณ หากคุณทราบว่าไฟล์อยู่ภายใต้เส้นทางเอกสาร ให้เพิ่มข้อจำกัด path: ที่เหมาะสม มิฉะนั้นให้ละเว้นสมมติฐานนั้น
ตีความผลลัพธ์ก่อนนำไปอ้างอิง
| ผลลัพธ์ | สิ่งที่ต้องตรวจสอบ | สิ่งที่ยังไม่ได้รับการพิสูจน์ |
|---|---|---|
| ชื่อไฟล์ที่ตรงกัน | วลีนั้นปรากฏในเนื้อหาหรือไม่ | ไฟล์สนับสนุนคำแถลง |
| ข้อความในเอกสาร | เวอร์ชันและเงื่อนไขของคุณสมบัติที่อยู่ใกล้เคียง | คุณสมบัติที่อธิบายได้รับการทดสอบแล้ว |
| ตัวอย่างหรือข้อเสนอ | อธิบายพฤติกรรมที่วางแผนไว้หรือเป็นตัวอย่างหรือไม่ | ฟังก์ชันได้รับการเผยแพร่แล้ว |
| ผลลัพธ์ว่างเปล่า | คลัง ประเภทคำค้น และข้อจำกัด | ข้อกล่าวอ้างไม่เคยมีอยู่ที่ใดเลย |
GitHub กำหนดให้ต้องลงชื่อเข้าใช้สำหรับการค้นหาโค้ดในคลังสาธารณะทั้งหมด และยังแยกความแตกต่างระหว่างเว็บไซต์ GitHub Pages กับเนื้อหาต้นทางของคลัง แหล่งที่มา บันทึกพื้นที่การค้นหาจริงและข้อจำกัดการเข้าถึง อย่าหลีกเลี่ยงข้อจำกัดการลงชื่อเข้าใช้ หรือถือว่าเว็บไซต์ที่ยังไม่ได้ค้นหาได้รับการครอบคลุมแล้ว
เชื่อมโยงข้อความกับเวอร์ชัน
เปิดไฟล์และอ่านส่วนที่เกี่ยวข้องทั้งหมด อ้างอิงข้อกล่าวอ้างที่ dokumented กับโครงการ อย่ารันโค้ดในคลังเพียงเพื่อทำภารกิจการอ่านนี้ให้เสร็จ และอย่าสรุปความน่าเชื่อถือของผลิตภัณฑ์จากดาวหรือชื่อบัญชี
เมื่อพบข้อความที่ถูกต้องแล้ว ให้ปฏิบัติตามคู่มือลิงก์ถาวรของ GitHub เพื่อเก็บเวอร์ชันที่ตรวจสอบแล้ว จากนั้นรายการตรวจสอบแหล่งที่มาสำหรับ AI จะช่วยแยกคำแถลงของเอกสารนั้นออกจากข้อสรุปที่โมเดลเพิ่มเข้ามา