Yıllarca kod yazıp incelediğimde, daha iyi çekme istekleri oluşturmak ve kodu daha verimli bir şekilde incelemek için birkaç sır öğrendim.
Tüm bu sırları yeni kitabım Pull İstekleri ve Kod İncelemesi'ne aktardım, ancak burada geliştirici faaliyetlerinizde zaten kullanabileceğiniz bu 13 ipucunun yer aldığı bir önizleme bulacaksınız.
Daha fazla ipucu düşünebilir misiniz? Yorumlarda paylaşın 😉
1. Kod incelemeye hazır olmadan önce PR'nizi oluşturun
PR taslağı, henüz özelliğiniz üzerinde çalışırken fikirlerinizi düzenlemenize ve ilerlemenizi belgelemenize yardımcı olur.
2. İnsanların PR'ınızı incelemesini sağlayın
Hızlı ve etkili bir inceleme almanın en iyi yolu, PR'nizi küçük ve iyi belgelenmiş (gerekli tüm bağlamla birlikte) tutmaktır. Ayrıca şimdi harika kodlar sunarak gelecekteki PR'ler için şansınızı artıracaksınız!
Tüm bu ipuçlarını ve daha fazlasını, daha fazla gerçek hayattan örnekler ve eyleme dönüştürülebilir bilgiler içeren ücretsiz kitabım Pull request and Code Review: Best Practices for Developers, Junior'dan Team Lead'e kadar bulabilirsiniz.
3. PR'ınızın ilk incelemecisi olun
Kendinizi incelemecinin yerine koyun, soruları tahmin edin ve onlara yardımcı olabileceğini düşündüğünüzde kendi yorum kodunuzu kullanın.
4. PR'ınıza doğru incelemecileri atayın
PR'ınızı tüm dünyaya atamayın. Onay için çok uzun süre beklemeden, ilgili incelemeyi almak için incelemecilerinizi dikkatli bir şekilde seçin.
5. Yorumlara duyarlı olun
Geri bildirime açık olun, açıklama isteyin, aynı fikirde olmadığınızı söyleyin (saygıyla) ve yorumlara her zaman yanıt verin.
6. İnsanların PR'larınızı incelemesini istiyorsanız, onların PR'larını siz de gözden geçirmelisiniz.
Herkesin gözden geçirmesi gereken çok sayıda PR'si vardır ve bunun için çok az boş zamanı vardır. Diğer PR'leri incelerseniz, sizinkini de inceleme şansınızı artırırsınız.
7. Kıdemsiz bir geliştirici olsanız bile kodu inceleyebilirsiniz
Kıdemsiz bir geliştirici olarak, kodun bir kısmını anlamadığınızda bunu başkalarına bildirebilirsiniz; çünkü bunun ekipteki herhangi bir geliştirici tarafından anlaşılması gerekir.
Bununla ilgili daha fazla bilgiyi yazımda Kıdemsiz bir geliştirici olarak kod incelemesi nasıl yapılır? .
8. Kod incelemesi sırasında doğru şeyleri kontrol edin
Kod incelemesinin amacı hataları ve uç durumları kontrol etmek ve uygulamaya meydan okumaktır. Ne küçük formatlama ya da stil tercihleri hakkında ayrıntıya girmek için ne de büyük ölçekli mimari tartışmalar için kullanılmamalıdır.
9. Yorumlarınızda doğru tonu kullanın
"Yapmalısın" yerine "neden olmasın"ı kullanın, açık ve olumlu olun ve değişiklik istediğinizde daima bir alternatif önerin.
10. PR'yi onaylamanız için bir değişikliğin gerekli olup olmadığı konusunda net olun
Tüm yorumlar bir değişiklik gerektirmez ve PR'nin onaylanması için istenen tüm değişiklikler gerekli değildir. Değişiklik acil değilse yorumunuzda net olun.
11. Yorumunuzu göndermeden önce inceleyin
İncelemenizi herkese açık hale getirmeden önce her yorumu yeniden okuyun: kullandığınız üslubu kontrol edin ve PR gönderen kişiye yardımcı olacak tüm bağlamı sağladığınızdan emin olun.
12. Gönderici istediğiniz tüm değişiklikleri yaptığında PR'yi onaylayın
İnceleyicinin, istediğiniz tüm değişiklikleri yaptıktan sonra iki gün onayınızı beklemesini istemezsiniz. İncelediğinizde, tüm düzeltmeler yapılır yapılmaz onaylayacağınızı varsayalım.
13. Bazı anlaşmazlıklar yorumlarda çözülemiyor
Bir yorum dizisi PR'nizde bir tartışma haline geldiğinde, onu kesip tartışmaya başka bir yerde, örneğin bir Slack başlığında devam etmeyi önerseniz iyi olur. Gerekirse bir toplantı düzenleyin ve/veya üçüncü bir tarafı dahil edin.
Bu kadar! Bu ipuçları hakkında ne düşünüyorsunuz? Diğer geliştiricilere vermek istediğiniz bir ipucunu düşünebilir misiniz?
Bunları burada yorumlarda paylaşın 👇
Bu ipuçlarını beğendiyseniz ve daha fazlasını öğrenmek istiyorsanız Çekme İstekleri ve Kod İncelemesi kitabıma göz atın; ücretsizdir!
Burada da yayınlandı.
