Dostlarımdan, kaynak kod komisyonlarına yorum eklemeye WANT'ı nasıl ikna edebilirim?

Subversion'un (işyerinde kullandıklarımız) komisyonlar hakkında yorum yapılmasını gerektirecek şekilde yapılandırılabileceğini biliyorum, ancak bunu basitçe açacak bir güç pozisyonunda değilim. Bunu biliyorum benim çabuk taahhüt nedenlerini kavramak, çok faydalı olduğunu, çünkü benim kaydedilmesini yorumlama nedeni ise sadece hafıza-cimnastiği olarak vardır. Ancak, bu her zaman aldığım iki yanıtla mücadele etmek için yeterli görünmüyor:

1. Çok uzun sürüyor ve sadece değişikliklerimı depoya almak istiyorum.
2. Sadece zorluklara bakmak yeterince kolay.

Hatta onlara sadece bir JIRA sorunu kimliği koymanın değerini ve meseleye otomatik olarak nasıl bağlandığını, ancak yine de onlarla uğraşmadığını gösteriyorum.

Hepsinden kötüsü , çağrıyı yapabilen kişi aynı kampta: rahatsız etmek istemiyor ve zorlukla ilgileniyor.

Yapılması gereken doğru şey olduğunu biliyorum, ama ışığı nasıl görmelerini sağlayabilirim? Arkadaşlarımın inancını ikna edemesem bile, yönetimi iş için yapılacak doğru şey olduğuna nasıl ikna edebilirim?

"Neden" e odaklan. Bunların hepsi farklara iyi bakıyor ve birinin kod bölümünün mantıksal akışını değiştirdiğini görmek ya da bunun gibi bir şey, ama neden değiştirdiler? Neden genellikle ilgili bilette (sizin için JIRA).

"Neden" in neden önemli olduğunu merak ediyor olabilirler, ancak 2 yıl içinde bu değişikliğin etkisine zarar veren bir hatayı yakaladığınızda, neden yapıldığını bilmek sadece yeni hatayı düzeltmek için değil, aynı zamanda önemli Eski böceğin yeniden ortaya çıkmasına neden olmuyorsun.

Denetim sebebi de var. Bağlama komisyonları ve bilet kimlikleri söylemeyi gerçekten kolaylaştırıyor, sürüm 2'yi zorluyoruz, bu, 23, 25, 26 ve 27 numaralı kusurları düzeltiyor, ancak 24 numaralı kusura karşı bir taahhüt yok, bu yüzden hala olağanüstü.

Birleşmeleri yapmalarını ve destekle uğraşmalarını sağlayın. Yine, belki de bunu yapacak bir durumda değilsindir, ancak kendini bir önceki sorundan bir sorunu giderecek biri olarak bulursan, kibarca çite gönder ve söyle. Ne yaptığını söyleyemem, çünkü hiçbir kesin yorum yok, bunu çözmek için gereken değişiklikleri yaptın.

Ayrıca dalları birleştirmek için de kullanılır. Sana düşüp düşmediğinden emin değilim, ama bu alanların yorumunu faydalı buldum.

Yine, teknenizde değil, bir yazılım ekibini yönettiğimde onlara iyi yorumda bulunup bulunmadıklarını söyledim, bunları haftalık durum raporunun liou'sunda kullanırdım. Bundan sonra mükemmel taahhütler aldım ve yönetici olarak neler olup bittiğini takip etmek benim için daha kolaydı.

Aynı sebeple check-in yorumlarına ihtiyacımız var. İşlerin izlenmesini kolaylaştırmak, okumak ve anlamak.

Bazen karşılaştırmak zorunda kalmazsınız, fakat sık sık yapmazsınız. Devs'i ikişer cümle okumak zorunda kaldıklarında karşılaştırmaya zorlamak toplam zaman kaybıdır. Geliştirici zamanın değerini neden göremediklerini merak ediyorum.

• İyi bir örnek ol. Kendi taahhüt mesajlarınızı parlayan bir kullanışlılık örneği yapın. Ekibinizin hikayeleri ve kusurları yönetmek için kullandığı diğer sistemlere referanslar ekleyin. Değişikliği özetleyen kısa bir açıklama ve değişikliğin neden gerekli olduğuna ve her başvuruda başka bir şey olmamasına ilişkin iyi bir açıklama yapın.
• İyi bir taahhüt mesajının olmayışı size fazladan iş çıkarırsa, gönderene bir soru sorun. Buna ısrarcı olun (ama bir pislik değil).
• Rolünüzü aşmıyorsa, taahhüt mesajlarını kullanarak günlük bir değişiklik günlüğü gönderen bir komut dosyası yazın. Bu, faydalı mesajların gözden geçirme işlemlerine göz atmanın ötesinde bir yararı olduğunu savınıza güvenilirlik kazandıracak. Bu aynı zamanda sizin tarafınızdan yönetimi sağlamanıza yardımcı olabilir, çünkü neler olduğunu günden güne görecekler.
• Müttefiklerinizi tanımlayın. Umarım sizinle aynı fikirde olan en az bir kişi vardır (belki de sessizce katılmıyorum). O kişiyi ya da o insanları bulun ve yalnız durmamanız için onları daha da ikna edin.
• Taahhütlü mesajların size zaman kazandırdığını (veya zayıf mesajların size zaman kazandırdığını) söyleme fırsatı size sunulduğunu gösterir.

Gıcırtılı tekerlek olmaktan korkma. Diğer insanların kötü alışkanlıklarına karşı savaşmak çoğu zaman yıpratma savaşıdır.

Bu duyduğum en tuhaf sorulardan biri olmalı. İnsanlar bir şeyi tamir etmek için saatler hatta günler harcıyorlar ve bir taahhüt mesajı yazmak için fazladan 2 saniye çok mu uzun? Bu kadar kısa görüşlü insanlarla çalışmaktan endişe edeceğimi söylemeliyim. Açıkçası araçlarını tam potansiyellerine bile yakın olmak için kullanmıyorlar.

İşte geçen hafta katıldığım kod incelemesinden bir örnek. Sürüm kontrol yazılımımız birleştirme tarihini korumaz, bu nedenle eski değişiklikler için yapıldığı şubeyi bulmanız gerekir, aksi halde taahhüt mesajı yalnızca "Y şubesinden birleştirilmiş" gibi bir şey gösterir. Şube Y "Şube Z ile birleştirildi" ifadesini gösterebilir ve bir şube, daha derinlerde iç içe geçme seviyelerinin gerçekte gerçek taahhüt mesajına sahiptir.

Yeni bir çalışan, tarihi doğru bir şekilde nasıl izleyeceğini bilmiyordu, bu da aslında sadece farklarla çalıştığı anlamına geliyordu. İzlemekte olduğu hatayla ilgili bazı kodlar yorumladı. Şifreyi uncommented, onun hata gitti. Hata ayıklama sırasında birisinin kodu yorumladığını ve yanlışlıkla kontrol ettiğini varsaydı.

Bu kod incelemesi sırasında bir çiftimiz için doğru gelmiyordu, bu yüzden gerçek taahhüt mesajını izledim ve bu kodu bir yıl önce kaldırmak için geçerli bir neden olduğunu gördüm. Yeni çalışan, yeni bulunan hatayı düzeltmek için kodunu düzeltmeyi başardı.

Ünite testleri gibi, bu tür gerilemeleri tanıtmaktan kaçınmanın daha iyi yolları var, ancak bir şekilde ünite testinde "boşa harcanan" zaman harcayan 2 saniyelik bir işlem mesajı ile uğraşamayan insanları göremiyorum.

Burada da aynı problemi yaşadım, bu yüzden Subversion'a ön işleme kancası ekledim, böylece Kullanıcı Öykü numarasıyla başlamayan herhangi bir işlemi kabul etmeyecekti (beklenen format için bazı temel kalıplar eşleşiyordu).

Onları 000-0000'e girmesini durduracak hiçbir şey yok, ancak bir kez sadece yıkıcı bir salak, kabul edilebilir bir sayıya sahip olduklarında bir sayı oluşturacak.

Bunu birkaç gün geçirdikten sonra bir dizi kullanıcı öyküsünün içine girmeye çalıştığını bulmaya çalıştım. Evet, başka bir yerde işlem başarısızlığı ile başa çıkmak içindi, ancak izlenmesi hala inanılmaz derecede değerli bir bilgi.

İyi taahhüt yorumları, herhangi bir iyi dokümantasyon, yavaş ve eskimiş beyniniz için bir önbellek veya uzun hata ayıklama / problem analizi / soruşturmasının sonucunun bir önbelleği gibidir.

Örneğin, ne zaman bir şey bulmak için zaman ayırırsanız, hata ayıklama, günlükleri analiz etme veya her neyse, bulgularınız ve sonuçlarınız değerlidir. Elbette çoğu görev tekrarlanabilir, ancak zaman alabilir. Bu yüzden sonuçlarınızı daima belgelendirmelisiniz

Yine de dokümantasyon zaman alır ve bazen “sadece bir kez yapmak zorunda kaldık, neden yazalım” gibi gerekli olmadığı hissediliyor. Sorun değil, ancak aynı şeyi ikinci kez yaptığınız anda sonuçları ilk kez belgelendirmediniz, o zaman sonuçları belgelemek akıllıca olacaktır.

Eğer meslektaşlarınız, sözlü yorumlar eklemek için çok fazla iş olduğunu düşünüyorlarsa, örneğin en azından Jira davası / Bilet'e, çözdüklerine dikkat edin, o zaman, her birinin nedeniyle ilgili sorulara sürekli cevap verme baskısı ile motive olmuş olabilirler. değişiklik kümesi.

Benim düşünceme göre, talep edilen bilgilerin bir fonksiyonu olarak belgeler üretilmelidir. Örneğin, posta yazışmaları oldukça iyi bir dokümantasyon sistemidir. Sorular daha sonra alınabilecek cevapları alır; posta listeleri ve forumlar pratikte bilgi tabanı olarak çalışır.

Ne yazık ki, çalıştığım yerde, posta 3 ay sonra otomatik olarak silinmektedir, bu nedenle her zaman pratikte çalışmaz.

Bağışlanmak, izin almak değil.

Sert olsa da, sadece bunu yaptım. Çoğunlukla gruptaki benimle aynı seviyede olan, destekleyenler ile muhalif insanlar arasında 50/50'lik bir bölünme vardı. Argümanlar “Rahatsız olamam” ve “Amaç nedir?” İdi. (Hem kayıtsızlığı hem de tembelliği gösterir, gerçek kaygıları değil).

İpin uzunluğunu basitçe ölçen ve reddetmeden önce biraz mizahi bir mesaj veren ön-işlemeli kanca ekledim. İsmimi mesaja koydum, böylece "bu öfke" nin sorumluluğu açıktı. Tabii ki, "muhalefet" kolayca kaldırabilirdi, ancak senaryoları kazmak bir yorum daha eklemek için daha fazla çaba harcayacaktı!

Bir hafta boyunca * * (tamamen silinen) veya kjhfkwhkfjhw gibi mesajlar ekledim . Bundan sonra, temel mesajlar görünmeye başladı.

Bir yıl ve şüpheciler anlamlı yorumlar kullanıyor ve gerçekte ne kadar kısa görüşlü olduklarını itiraf ediyor. Hiçbir zaman uzlaşma sağlayamadım, ama kesinlikle affedilmiş ve belki de güvenilirlik elde ettim. Çalışır, insanlar kullanır.

Daha uygun biri olmak istiyorsanız (veya başınızın belaya gireceğini hissederseniz), deneme süresi için kesin bir kanca eklemek için izin isteyin. İnsanlar 2 hafta veya 4 hafta içinde beğenmezlerse, dışarı çıkaracağınızı söyleyin. Muhtemelen, ilgilerini kaybedecekleri ... ya da hoşlandıkları gibi büyüyecekler.

Genelde insanları:

• diyalektik iyi destekleyici nedenlerle
• örnek olarak lider
• yıpranma

Ekibimizin yeterince kötü bir şey yapmasını isteseydim, gelene kadar rahatsız etmeyi sürdürürdüm. Zaten X yapıyor olsaydık, zamandan / paradan tasarruf edebileceğimizi gösterebileceğim o zamanlarda rahatsız etmeye çalışıyorum.

Yorum yapmak için ek iyi nedenler:

• Yorumlardan otomatik olarak ChangeLog oluşturma.
• Hata düzeltmeleri için denetim izi, özellik ekleme. Bu, takım içinde ve dışında faydalıdır.
• Taahhüt posta daha yararlı hale getirin.
• Geliştiriciye X'in ne yapacağını sormasını engelleyin (hemen hemen her taahhütten sonra).

• 6 ay önce yapılan gizli bir şey için SVN kayıtlarını kontrol et.
• Ne zaman yapıldığını söylemeden bu konuda bazı sorular sorun
• ???
• kâr

İyi yorumlar eklemek istemelerini nasıl sağlarsınız?

Yeni sahip olduğum bir meslektaşımla olan deneyimimden. Bir projenin sonunda, proje boyunca yapılan tüm değişikliklerin bir özet belgesini yazmak zorunda kaldık. İyi taahhüt notları vermemiş olmak, meslektaşım bu görevi oldukça zaman alıcı buldu ve şimdi her bir taahhütle birlikte oldukça uzun yorumlar yapmaya başladı.

Öyleyse - paket servis - bir çözüm, geliştiricilerin proje sonunda hangi dosyalarda hangi değişikliklerin yapıldığını, hangi dosyaların eklendiğini / çıkarıldığını ve neden çıkarıldığını ayrıntılandıran özet belgeler yazmaları olabilir.

Bunu kapalı kapılar ardındaki yönetime önerin:

En kötü senaryo gerçekleşir: Tüm üst düzey geliştiriciler kapıdan çıkar.

Şirket boş geliştirici koltuklarını doldurmak için mücadele ederken, yönetim ekibi sistemin durumunu müşteriye iletmekle görevlidir.

Onlara, uygulamanın tarihini yeniden yapılandırmada işlerini kolaylaştıracağını düşündüklerini sorun:

Sade İngilizce okumak sistemin değişen durumunu açıkça tanımlayan taahhütler veriyor mu?

Yoksa kod farklılıklarına bakmayı ve kendi başlarına çözmeyi mi tercih ederler?

Onları ikna etmenin bir yolu aslında hissettiğiniz acıyı deneyimlemek olacaktır.

Örneğin, şu problem üzerinde çalıştıklarını varsayalım: Aynı kod için başka bir hata düzeltmesi (oh ironi) uygulandığında bir şekilde ortaya çıkan bir hatayı var. Bunu yalnızca taahhüt mesajlarını araştırmakla araştırabilmek harika olurdu (ve böylece kimin yazdığını bulmak).

Başka bir yol, onlara taahhüt mesajının neden bir şeyin belirli bir şekilde uygulandığına dair bir ipucu vermek için yararlı olabileceğini açıklamak olacaktır. Taahhüt mesajı sadece "X özelliği" yazsa bile, onu uygulayan bir ipucu alabilirsiniz, böylece kiminle konuşacağınızı bilirsiniz.

Ancak, bu her zaman aldığım iki yanıtla mücadele etmek için yeterli görünmüyor:

1. Çok uzun sürüyor ve sadece değişikliklerimı depoya almak istiyorum.
2. Sadece zorluklara bakmak yeterince kolay.

Diğer geliştiricilerinize, yorumlarda bulunmaktan başka bir fayda elde edebilmek için bir meydan okuma atmaya çalıştınız mı? Buna birkaç farklı açıdan bakabilirsiniz:

1. Oyunlarını canlandırmak - Bu alması daha zor bir bakış açısı olabilir, ancak buradaki fikir bunu bir süre boyunca yapacakları ve alışkanlığın diğer tarafa gitmesinin daha uzun süreceği fikrine alışmaları olacaktır. Buradaki bir diğer nokta, yorumlar ne kadar incelenir? Eğer yorumda kısa bir hikaye istiyorsan onların amacını anlayabilirim.
2. Değişikliği Sübvanse Etme - Bu, bunu denemek için ilk katılımın yapılmasının veya değişikliğin bir süre yapılması için başka tür bir teşvik sunmanın bir yolu olarak bir tür yarışmanın olacağı yerdir.

Göz önünde bulundurulması gereken başka bir şey ise, geliştirici arkadaşlarınızın çalıştığınız yerde ne yönettiğini ne kadar iyi biliyorsunuz? Dün 10 şey yapmaya çalışıyorlarsa, o zaman işe yarayan bir şey olarak gördüklerini değiştirmek istemeyebileceklerini anlayabilirim. Onlara "Hayır, bu işe yaramaz mı?" Demeye mi çalışıyorsun? Eğer öyleyse, o zaman bu konuda nasıl biraz savunma veya mücadele olabileceğini görebiliyorum. Onlara "Bu işe yarayabilirken, daha iyi olabilecek bir alternatif var ..." demeye çalışıyorsanız, bir şansınız olabilir. Burada "Senden daha Holier" bir tutuma sahip olmak sana yardım etmeyecek, IMO.

Bu bakmanın bir başka yolu kariyerlerini büyümeye katılan geliştirici (ler) için bir yol olarak - onlar gerektiğini kendi belgelerine işlerinin.

Yukarıda belirtilen makalede ortaya konan diğer noktalara ek olarak, bir değişikliğin nerede / ne zaman / neden yapıldığını bulmak için kod değişikliklerini inceleyebilme özelliği vardır. Zor bir böceğin izini sürmek hayati olabilir.

Onları taahhütlerinize yorum yapmanın önemli olduğuna ikna ettikten sonra, taahhütler hakkında yorum yapmaya zorlayan bir senaryo oluşturabilirsiniz, aksi halde başarısız olur. Anlamlı bir yorum yapabilmesi için en az sayıda karakter bile belirleyebilirsiniz. Bu onlara "hatırlamalarına" yardımcı olacaktır.

Ancak, @Kevin'in dediği gibi Nedenini anlamaları önemlidir, yoksa başka herhangi bir rastgele yorum eklerler.

Kod incelemeniz var mı? Yardımcı olabilecek bir şey, herhangi bir taahhüt veya birleşmenin başka bir geliştirici tarafından bakılması ve onaylanması gerektiğine dair bir kural oluşturmaktır. O zaman, eğer inceleme uzmanıysanız, geliştiriciden size ne yaptığını açıklamayı taahhüt etmesini istemeniz gerekir. Bunu yaptıktan sonra, az önce size söylediklerini yorum yazmasını istemeniz gerekir. Genelde yapılan değişiklikler tutarlı bir şekilde açıklanamadığında, bu değişikliklerin ilk başta yapılmaması gerektiği anlamına gelir.

Yine de söylemeliyim ki, insanlar yorum yapmak kadar açık bir şekilde işe yarar bir şeye nasıl itiraz edebilirler? Hiç uzun sürmez ve iyi harcanan bir zamandır. Bir yorum yazmak sizi henüz ne yaptığınız hakkında düşünmeye zorlar. Hatta yaptığınız şeyleri gerçekten yaptığınızdan ve aptalca bir şey yapmadığınızdan emin olmak için farklara bakmanıza bile neden olabilir.

Yorumları yazmazsanız, özensiz ve disiplinsizsiniz. Ve yorumları yazmanız gerekmemesi konusunda ısrar ediyorsanız, isteyerek ihmal edersiniz.

Onlara 50.000 çizgi yönteminden oluşan usule ilişkin karışıklığınızı sürdürme şansını elde etmenin tek yolunu söyleyin, ardından gelecekte kod tabanınızı şişiren bir sürü anlamsız yorumla uğraşmanıza gerek kalmayacak şekilde daha iyi ve daha açık kod yazmayı düşünün.

Bu bir süreç değiştirme öğesidir: Bir yöneticinin, yorumların kalite güvencesi de dahil olmak üzere yalnızca kod üzerindeki kalite güvence kontrolleri için "x" ile "Y" arasında geliştirilen bir kod atayın.

Kendi kuruluşumda geliştiricilerin kendi kodlarının son kalite güvencesini yerine getirmelerine ve kontrol etmelerine izin verilmiyor, bunun başka bir geliştirici tarafından yapılması gerekiyor. Kalite Güvence Kontrolünün bir kısmı yorum, yani yorum yok, giriş yok. “Sanatımızın” aslında bir başkasının sözleşmeye dayalı fikri mülkiyeti olduğu bir çok sözleşmeli iş yapıyoruz, bu nedenle başkalarının kodumuzu anlayabilmesi ve kaldırabilmesi gerekir. Ayrıca, uzun bir aradan sonra projelerin bize geri döndüğü zamanlar vardır ve 18-24 ay sonra kodları alabilmemiz ve önümüzde kod eserine neden, nerede ve nasıl geldiğimizi anlamamız gerekir. Bu taahhüt yorumlar yazmak için bir kendi kendine hizmet motivasyon sağlar.

Geliştiricilerden bazı birleştirmeler yapmalarını ve geçmişe bakmalarını ve geçmişten gelen birkaç dosyayı karşılaştırmalarını isteyin.

Muhtemelen, sizden ertesi gün daha sonra yorum yazmanızı isteyeceklerdir.

İşte bazı tavsiyeler:

1. Dünyayı değiştirmeye çalışmayın. Başarısız olacaksın.
2. Bunun yerine, herkesin biraz farklı şekilde çalıştığını doğrulamalısınız. Tek beden herkese uymuyor.
3. İnsanların çalışma süreçlerinde belirli adımlar atılması çok kötü. Bu işlemlerin değiştirilmesi 10 yıl sürer. Bir sonraki son tarihten önce bunu yapmalarını istiyorsun.
4. Basit işlem değişiklikleri bile uzun zaman alabilir.
5. Taahhütler hakkındaki bazı küçük yorumlar bu süreçleri değiştirmek için çok önemsiz.
6. Kaliteli işler yaptıklarını varsayabilir, ancak adımları seçmek için yeterli özgürlüğü vermelisiniz. Deneyimli geliştiriciler için bazı külfetli adımlar gerekmeyebilir.
7. Yeni doğanlara bakıcılık yapıyorsanız, daha güçlü süreçler gerekli olabilir, ancak deneyimli geliştiriciler saçmalıklarla başa çıkmamalı.
8. İşin nasıl yapılması gerektiğine ilişkin draconian kısıtlamaları uygulamak asla işe yaramayacak, yalnızca insanları yavaşlatabilir (çok hızlılarsa iyi olabilir)
9. İşlerini yapmanın tek doğru yol olduğunu düşünen birçok insan var. Umarım onlardan biri değilsindir.

Kaynak kontrolünüz bunu sağladığında, yorumlanmamış herhangi bir komisyonu önlemek için zorunlu yorumları açın. Yeterince basit ve herkes yakında 5 saniye bir yorum yazmanın ağrısız olduğunu anlayacaktır.

Ancak yorumlanmamış taahhütler en küçük olumsuzluklardan biri. Tek bir taahhüdün yorumlanmadığı birçok başarılı projenin parçası oldum. Külotunu üzerine atma.