Desteklemeniz gereken pasajı seçin
Kendi projenizin herkese açık README dosyasındaki bir kurulum ifadesini, bir makalede bahsetmeden önce kontrol ettiğinizi varsayalım. Tam pasajı ve yakınındaki koşulları bulun. Bir depo başlığı veya profil biyografisi, ifadeyi içeren dosyanın yerini tutmaz.
Görevi belgeyle sınırlı tutun. Projeyi çalıştırmanız, kişisel iletişim bilgilerini incelemeniz veya bir katkıda bulunanın hesabını özel bir kimliğin kanıtı olarak görmeniz gerekmez.
Değişen dal görünümünü sürüm bağlantısıyla değiştirin
GitHub, sıradan bir dosya görünümünün genellikle bir dalın güncel ucunu gösterdiğini, bu nedenle içeriğinin commit’ler geldikçe değişebileceğini açıklar. Dosyayı görüntülerken y tuşuna basmak, URL’yi dal adı yerine belirli bir commit kullanan kalıcı bir bağlantıya dönüştürür. Kaynak
Bu işlemden sonra gerçekten görüntülenen URL’yi kopyalayın. Yeniden açın ve aynı dosyayı ve pasajı gösterdiğini doğrulayın. Bir commit tanımlayıcısı uydurmayın veya açmadığınız bir arama önizlemesinden alıntı oluşturmayın.
Güncel dal adresini de istiyorsanız ayrı bir not tutun. Sürüm bağlantısı “hangi ifadeyi inceledim?” sorusunu yanıtlarken, dal görünümü projenin şu anda ne sunduğunu kontrol etmenizi sağlar.
Başka bir okuyucu için yeterli bağlamı kaydedin
| Alan | İncelemenizden kaydedin | Amaç |
|---|---|---|
| Depo ve dosya | Gerçek proje ve dosya yolu | Alıntılanan belgeyi tanımlamak |
| Commit tanımlayıcısı | Kopyalanan kalıcı bağlantıdaki sürüm | Bu anlık görüntüyü sonraki düzenlemelerden ayırmak |
| Destekleyici pasaj | Kısa bir alıntı veya sadık bir özet | İddiayı incelenen ifadeyle sınırlamak |
| Yakındaki koşullar | Sürüm, ortam veya özellik sınırları | Bir nitelendirmeyi atlamamak |
| Erişim tarihi | Kaynağı açtığınız zaman | İnceleme zamanınızı yayın geçmişinden ayırmak |
Bir dışa aktarma özelliğinin deneysel olduğunu söyleyen örnek bir README için desteklenen ifade “deneysel” nitelendirmesini korur. Kalıcı bir URL, bunu test edilmiş bir garanti olarak yeniden yazmayı haklı çıkarmaz. Bu örnek alıntılama uygulamasını gösterir; gerçek bir depo hakkında bir rapor değildir.
Eski bir ifadenin hâlâ geçerli olup olmadığına karar verin
Mevcut dal farklıysa her iki gözlemi de saklayın: alıntıladığınız önceki sürüm ve gerçekten açtığınız güncel ifade. Daha eski bir alıntıyı sessizce değiştirirken onu aynı inceleme olarak tanımlamaya devam etmeyin.
Bir dosya planlar, örnekler veya güncelliğini yitirmiş talimatlar içerebilir. Bu ifadeleri uygulamayı bağımsız olarak test ettiğinizi iddia etmek yerine projeye atfedin. Erişim daha sonra başarısız olursa bu sınırlamayı kaydedin; bir sürüm tanımlayıcısı kalıcı barındırma veya izin vaadi değildir.
Bu aynı zamanda imzalı commit rozetinden de ayrıdır. GitHub Doğrulanmış rozet rehberi bu farklı sinyali ele alır. Herkese açık belgelerin daha geniş bir sentezi için AI kaynak inceleme kontrol listesini kullanın ve her önemli iddianın dayandığı tam sürümü saklayın.