Pilih bagian yang perlu Anda dukung
Misalkan Anda memeriksa pernyataan instalasi di README publik proyek Anda sendiri sebelum menyebutkannya dalam sebuah artikel. Temukan bagian yang tepat dan kondisi di sekitarnya. Judul repositori atau biografi profil tidak menggantikan file yang memuat pernyataan tersebut.
Batasi tugas pada dokumen itu. Anda tidak perlu menjalankan proyek, memeriksa informasi kontak pribadi, atau menganggap akun kontributor sebagai bukti identitas pribadi.
Ganti tampilan cabang yang berubah dengan tautan versi
GitHub menjelaskan bahwa tampilan file biasa umumnya menampilkan kepala cabang saat ini, sehingga isinya dapat berubah seiring commit yang masuk. Saat melihat file, menekan y mengubah URL menjadi permalink yang menggunakan commit tertentu alih-alih nama cabang. Sumber
Salin URL yang benar-benar ditampilkan setelah tindakan itu. Buka kembali dan pastikan URL tersebut menampilkan file dan bagian yang sama. Jangan mengarang pengenal commit atau menyusun kutipan dari pratinjau pencarian yang belum Anda buka.
Simpan catatan terpisah jika Anda juga menginginkan alamat cabang saat ini. Tautan versi menjawab “kata-kata apa yang saya periksa?” sedangkan tampilan cabang memungkinkan Anda memeriksa apa yang ditampilkan proyek sekarang.
Catat konteks yang cukup bagi pembaca lain
| Kolom | Catat dari pemeriksaan Anda | Tujuan |
|---|---|---|
| Repositori dan file | Proyek dan jalur file yang sebenarnya | Mengidentifikasi dokumen yang dikutip |
| Pengenal commit | Versi dalam permalink yang disalin | Membedakan cuplikan ini dari suntingan berikutnya |
| Bagian pendukung | Kutipan singkat atau ringkasan yang setia | Membatasi klaim pada kata-kata yang diperiksa |
| Kondisi di sekitarnya | Batasan versi, lingkungan, atau fitur | Menghindari menghilangkan kualifikasi |
| Tanggal akses | Kapan Anda membuka sumber | Memisahkan waktu tinjauan Anda dari riwayat publikasi |
Untuk README ilustratif yang menyatakan fitur ekspor bersifat eksperimental, pernyataan yang didukung tetap mempertahankan “eksperimental.” URL yang stabil tidak membenarkan penulisan ulang sebagai jaminan yang telah diuji. Contoh ini menggambarkan praktik pengutipan; ini bukan laporan tentang repositori nyata.
Putuskan apakah pernyataan lama masih relevan
Jika cabang saat ini berbeda, pertahankan kedua pengamatan: versi sebelumnya yang Anda kutip dan kata-kata saat ini yang benar-benar Anda buka. Jangan diam-diam mengganti kutipan lama sambil terus menggambarkannya sebagai tinjauan yang sama.
Sebuah file dapat memuat rencana, contoh, atau instruksi yang sudah usang. Atribusikan pernyataan tersebut kepada proyek alih-alih mengklaim Anda menguji implementasinya secara independen. Jika akses kemudian gagal, catat keterbatasan itu; pengenal versi bukan janji hosting permanen atau izin.
Ini juga terpisah dari lencana commit bertanda tangan. Panduan lencana Terverifikasi GitHub membahas sinyal yang berbeda itu. Untuk sintesis dokumen publik yang lebih luas, gunakan daftar periksa tinjauan sumber AI dan pertahankan versi persis yang menjadi dasar setiap klaim material.