Teknoloji ipuçlarını kendin uygula
İçerik
Son yazılar
Biz kimiz
Yazılım Atölyesi, adım adım teknoloji rehberleriyle kendi başına öğrenip uygulama yapmak isteyenlere yardımcı olur. Pratik ipuçları, araç önerileri ve çözümler bulacaksınız.

GitHub Pull Request İnceleme Süreci

Pull request, kodun "bitti" ile "yayında" arasındaki son kapısıdır. Bu kapıda ne kadar dikkatli davranırsan, üretimde o kadar az sürprizle karşılaşırsın. Ama çoğu ekipte inceleme ya çok yüzeysel geçer (iki dakikada "LGTM") ya da haftalarca sürüncemede kalır. İkisi de aynı sebepten olur: sürecin adımları yazılı değildir.

Aşağıdaki akışı tek başına, kişisel bir depoda bile uygulayabilirsin. Kendi PR'ını kendin incelemek, alışkanlık kazanmanın en hızlı yolu. Git komutlarında rahat değilsen, dallanma ve rebase konularını Git Workflow Pratik Rehberi'ndeki adımlarla tazelemek işini kolaylaştırır.

İncelenebilir Bir Pull Request Hazırlamak

İyi bir pull request inceleme süreci, incelemeciden değil PR'ı açan kişiden başlar. Okunamayan bir diff, en iyi incelemeciyi de yorar.

Değişikliği küçük ve tek amaçlı tut

Açıklamayı kullanım kılavuzu gibi yaz

İncelemeci senin kafandakini bilmiyor. Açıklamada şu dört başlık olsun:

  1. Ne: Tek cümleyle değişiklik.
  2. Neden: Hangi issue, hangi hata, hangi ölçüm.
  3. Nasıl test ettim: Çalıştırılan komutlar, gidilen ekranlar, istek örnekleri. API değişikliği varsa örnek istek/yanıt yapıştır; REST API Test Etme Araçları sayfasındaki koleksiyon mantığı burada işe yarar.
  4. Riskler: Geri alınabilir mi, veritabanı migration'ı var mı, feature flag arkasında mı.

İlk incelemeyi kendin yap

İnceleme Sürecini Yürütmek: Diff'ten Merge'e

Diff'i doğru sırada oku

Rastgele dosya açmak yerine sabit bir sıra izle:

  1. Açıklama ve issue.
  2. Testler. Yeni davranış testte görünüyorsa, kodun ne yaptığını zaten anlamışsın demektir.
  3. Veri modeli, migration, şema. Geri dönüşü en pahalı kısım burası. Sorgu ekleniyorsa indeks var mı diye düşün; SQL Veri Tabanı Optimizasyon İpuçları'ndaki N+1 ve indeks kontrolleri iyi bir kontrol listesi.
  4. İş mantığı.
  5. Arayüz, stil, kozmetik dosyalar.

Karmaşık PR'larda dalı yerel makinene çek ve çalıştır. gh pr checkout ya da düz Git ile indirip editörde gezmek, tarayıcıdaki diff'ten çok daha fazlasını gösterir. Editörünü hızlı gezinmeye ayarlamak için VS Code'u Hızlandırma Tricksleri'ndeki kısayollar burada doğrudan işe yarar.

Yorumları etiketle ve niyetini belirt

Belirsiz yorum, gereksiz tartışma üretir. Yorumun başına ne beklediğini yaz:

EtiketAnlamıMerge'i engeller mi?
blockerHata, güvenlik açığı, veri kaybı riskiEvet
soruAnlamadım, açıklama istiyorumCevaba göre
öneriDaha iyi bir yol var, karar sendeHayır
nitZevk meselesi, isimlendirme, biçimHayır