GitHub pull request'lerini Codex ile inceleme
GitHub pull request'lerini Codex ile inceleme
GitHub pull request'leri için Codex kod incelemesini ayarlayın, @codex review ile inceleme isteyin, otomatik incelemeleri etkinleştirin ve inceleme yönergelerini özelleştirin.
GitHub pull request'leri için yüksek değerli bir ek inceleme turu elde etmek üzere Codex kod incelemesini kullanın. Codex, pull request farkını inceler, deponuzun yönergelerini izler ve ciddi sorunlara odaklanan standart bir GitHub kod incelemesi yayımlar. Araştırma önizlemesinde sunulan Security Review, bir pull request'teki olası güvenlik sorunlarını daha ayrıntılı biçimde inceler.
İzleyin: Codex kod incelemesi adım adım anlatımı
Başlamadan önce
Şunlara sahip olduğunuzdan emin olun:
- İncelemek istediğiniz depo için ayarlanmış Codex cloud.
- Codex kod incelemesi ayarlarına erişim.
- Codex'in depoya özgü inceleme yönergelerini izlemesini istiyorsanız bir
AGENTS.mddosyası.
Codex kod incelemesini ayarlama
Otomatik incelemeleri yapılandırmak için bağlı bir GitHub deposuna ve depo ayarları üzerinde GitHub push veya yönetici iznine ihtiyacınız vardır.
- Codex cloud kurulumunu yapın.
- Codex ayarlarına gidin.
- Deponuz için Kod incelemesi özelliğini açın.
Codex incelemesi isteyin
- Bir pull request yorumunda
@codex reviewifadesinden bahsedin. - Codex'in tepki vermesini (👀) ve bir inceleme yayımlamasını bekleyin.
Codex, tıpkı bir ekip arkadaşı gibi pull request üzerinde bir inceleme yayımlar. GitHub'da Codex yalnızca P0 ve P1 sorunlarını işaretler; böylece inceleme yorumları yüksek öncelikli risklere odaklı kalır.
Otomatik incelemeleri etkinleştirin
Codex'in her pull request'i otomatik olarak incelemesini istiyorsanız
Codex ayarlarında Otomatik incelemeler seçeneğini açın.
Bir kullanıcı inceleme için yeni bir PR açtığında Codex, @codex review yorumuna
gerek kalmadan bir inceleme yayımlar.
Codex'in neleri incelediğini özelleştirme
Codex, deponuzda AGENTS.md dosyalarını arar ve geçerli kod inceleme
kurallarını izler. Kuralların yönettiği koda en yakın dosyaya bir ## Code Review Rules
bölümü ekleyin. Yararlı olduğunda ilgili denetimleri gruplamak için ###
başlıklarını kullanın.
Örneğin bir deney raporlama hizmeti, gösterim sonrası davranışların karşılaştırma kohortunu değiştirmesini önleyebilir:
## Code Review Rules
### Experiment cohorts
- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
Safe path: build cohorts from assignment or exposure; report conversion as an outcome.Depo genelindeki kuralları kök AGENTS.md dosyasına, hizmete özgü kuralları
ise services/experiment_reporting/AGENTS.md gibi iç içe bir dosyaya yerleştirin. Codex,
değiştirilen her dosyayı kapsayan kök ve daha özel yönergeleri uygular; böylece
ilgisiz değişikliklerin hizmete özgü bağlamı taşıması gerekmez.
İnceleme yapanların sıkça açıkladığı denetimleri kodlayan iki veya üç kısa kuralla başlayın. Yararlı kurallar:
- Sonuç doğuran, depoya özgü davranışa odaklanın. İşaretlenecek uyumluluk kısıtını, veri sınırını veya güvenli olmayan yan etkiyi ve bunun neden önemli olduğunu açıklayın.
- Güvenli yolu veya istisnayı belirtin. Codex'e gerçek bir sorunu beklenen davranıştan ayıracak kadar bağlam verin.
- Kuralları kapsamlı ve kalıcı tutun. Değişebilecek işlev adları yerine sonuçları tercih edin ve yönergeleri yönettiği kodun yakınına yerleştirin.
- Mekanik denetimleri CI'a bırakın. Biçimlendirme, lint ve diğer belirlenimci denetimleri inceleme kurallarına eklemeyin.
Temsilî bir pull request açıp @codex review ile inceleme isteyin.
Kuralları gördüğünüz bulgulara ve geri bildirimlere göre iyileştirin; gürültü
üreten yönergeleri daraltın veya kaldırın.
Kod inceleme kuralları Codex'e yol gösterir; testlerin, dal korumalarının veya zorunlu onayların yerini almaz.
Tek seferlik bir odak için bunu pull request yorumunuza ekleyin:
@codex review for issues in the database migration
Güvenlik İncelemesi
Güvenlik İncelemesi, çekme isteklerindeki güvenlik sorunlarına özellikle dikkat etmek isteyen müşterilere yönelik ek bir incelemedir. Çekme isteği farkını, destekleyici depo bağlamını ve yapılandırılmış tehdit modellerini veya güvenlik yönergelerini analiz ederek güvenliğe özgü riskleri Kod İncelemesinden daha ayrıntılı inceler.
Kod İncelemesi, genel incelemesinin bir parçası olarak güvenlikle ilgili sorunları da belirleyebilir. Bu nedenle Kod İncelemesi ile Güvenlik İncelemesi bulguları arasında zaman zaman örtüşme görebilirsiniz.
Güvenlik İncelemesini ayarlayın
Daha ayrıntılı kurulum talimatları ve yapılandırma seçenekleri için Güvenlik İncelemesi sayfasına bakın.
- Codex cloud kurulumunu yapın.
- Codex ayarları sayfasına gidin.
- Repository preferences altında, hangi çekme isteklerinin Güvenlik İncelemesine tabi tutulacağını ve incelemenin ne zaman çalışacağını seçin. Kod İncelemesiyle birlikte çalıştırmak için Whenever code review runs seçeneğini belirleyin.
Güvenlik İncelemesi isteyin
Manuel olarak Güvenlik İncelemesi istemek için bir çekme isteğine şu yorumu ekleyin:
@codex security review
İnceleme sürerken Codex tepki verir, ardından güvenlik bulgularını doğrudan çekme isteğinde yayımlar. İlişkili Codex görevini açın ve tam raporu görüntülemek için Security Report sekmesini seçin.
İnceleme bulgularını ele alma
Codex bir inceleme yayımladıktan sonra aynı pull request'e başka bir yorum bırakarak sorunları düzeltmesini isteyebilirsiniz:
@codex fix the P1 issueCodex, bağlam olarak pull request'i kullanan bir cloud chat başlatır ve gerekli izne sahipse düzeltmeyi dala geri gönderebilir.
Codex'e başka görevler verme
Bir yorumda @codex ifadesini review dışında herhangi bir şeyle birlikte kullanırsanız Codex, pull request'inizi bağlam olarak kullanan bir cloud chat başlatır.
@codex fix the CI failuresKod incelemesi sorunlarını giderme
Codex tepki vermez veya inceleme yayımlamazsa:
- Codex ayarlarında depo için Kod incelemesi seçeneğini açtığınızı doğrulayın.
- Pull request'in Codex cloud kurulmuş bir depoya ait olduğunu doğrulayın.
- Pull request yorumunda tam olarak
@codex reviewtetikleyicisini kullanın. - Otomatik incelemeler için Otomatik incelemeler seçeneğini açtığınızı ve pull request olayının inceleme tetikleyicisi ayarlarınızla eşleştiğini denetleyin.