Pilih proyek publik dan klaimnya
Mulailah dengan repositori publik tertentu untuk proyek Anda sendiri atau organisasi yang sedang Anda teliti. Salin nama owner dan repositori lengkapnya. Tuliskan pernyataan fitur persis yang perlu Anda temukan, dan bedakan dokumentasi dari pengujian implementasi.
Gunakan prosedur ini untuk menemukan dokumentasi proyek. Jangan mencari kredensial yang terekspos, informasi kontak pribadi, atau cara untuk melewati kontrol akses repositori.
Gunakan kualifikasi pencarian kode secara sengaja
Dokumentasi pencarian kode GitHub menjelaskan bahwa istilah tanpa kualifikasi dapat cocok dengan path file atau isinya. repo: membatasi pencarian ke nama owner/repositori lengkap, path: mempersempit path, dan content: mengharuskan istilah muncul di isi file. String dalam tanda kutip dapat mencari kata-kata persis. Aturan ini berlaku untuk pencarian kode, tidak otomatis untuk pencarian issue atau profil. Sumber
Untuk repositori ilustratif bernama example-owner/example-project, kueri dapat berupa:
repo:example-owner/example-project content:"export format"Nama dan frasa tersebut adalah placeholder, bukan pencarian nyata yang kami lakukan. Gantilah dengan repositori yang Anda berwenang untuk ditinjau dan kata-kata yang relevan dengan pertanyaan Anda. Jika Anda tahu file berada di bawah path dokumentasi, tambahkan pembatasan path: yang sesuai; jika tidak, hilangkan asumsi itu.
Tafsirkan kecocokan sebelum mengutipnya
| Hasil | Yang perlu diperiksa | Yang tidak dibuktikan |
|---|---|---|
| Nama file cocok | Apakah frasa muncul di isi | File mendukung pernyataan |
| Bagian dokumentasi | Kualifikasi versi dan fitur di sekitarnya | Fitur yang dijelaskan telah diuji |
| Contoh atau proposal | Apakah menjelaskan perilaku yang direncanakan atau ilustratif | Fungsionalitas telah dirilis |
| Hasil kosong | Repositori, jenis kueri, dan pembatasan | Klaim tidak pernah ada di mana pun |
GitHub mendokumentasikan persyaratan masuk untuk pencarian kode di semua repositori publik. GitHub juga membedakan situs web GitHub Pages dari konten sumber repositori. Sumber Catat permukaan pencarian dan batas akses yang sebenarnya; jangan melewati pembatasan masuk atau menganggap situs web yang tidak dicari sudah tercakup.
Kaitkan bagian dengan versi tertentu
Buka file dan baca bagian relevan secara lengkap. Atribusikan klaim yang didokumentasikan kepada proyek. Jangan menjalankan kode repositori hanya untuk menyelesaikan tugas membaca ini, dan jangan menyimpulkan keandalan produk dari bintang atau nama akun.
Setelah bagian yang benar ditemukan, ikuti panduan permalink GitHub untuk mempertahankan versi yang diperiksa. Daftar periksa tinjauan sumber AI kemudian membantu memisahkan pernyataan dokumen tersebut dari kesimpulan yang ditambahkan model.