Önemsiz düzeltmeleri günlüğe kaydetmeli miyim?


28

İkilik bir kod dükkanındayım. Ve bir hata izleyicinin programcı sayısının bire eşit veya daha fazla olduğu yerlerde yararlı olduğunu anladığım halde, günlük hatalarının, değişikliklerin ve düzeltmelerin önemsiz oldukları zamana değecek kadar ikna olmadım. Basit bir hata bulduğumda anlıyorum, düzelttim ve bazı testlerden geçirdim. Ve sonra farkettim ki giriş yapmam gerekiyor.

Teoride, hata günlüğü hata bulma ve hata düzeltme arasında bir yerde yapılması gerektiğini biliyorum, ancak bunu düzeltmek günlüğe kaydetmekten daha hızlı ise, bir sürükleme gibi görünüyor. Daha büyük kod dükkanlarında, patron kimin ne yaptığını önemser ve başkalarının neyle uğraştığını bilmek güzeldir.

Kendimi önceden düzelttiğim şeyleri açıklarken bulup anında kapatıyorum. Herkesin bu kapalı hatayı tekrar görebileceğine dair şüphelerim var. İşlemi kesmenin zamanı geldi mi?


6
Bir hata bulduğunuzda, hatanın kağıda ne olduğunu yazın. Hatayı düzeltirken hangi dosyaların değiştirildiğini not alın. Düzeltmeyi göndermeden önce, hatayı günlüğe kaydedin, ardından değişiklikleri gönderin. Bunu her zaman bir alışkanlığa sahip olacaksanız yaparsanız, şu anda kötü bir alışkanlığınız vardır, günlüğe kaydetme hataları zaman kaybı değildir.
Ramhound,

5
Bu böceklerin önemsiz olduğuna nasıl emin olabilirsiniz?

2
@ashansky, sorumun ikinci cümlesini okudunuz mu?
Philip

1
Kendi çalışmanızı kaydetmemek kesin bir yoldur: a) bunun için kredi alamamak ve b) 'X neden yapılmadı ve neden Y üzerinde çalışıyorsun?'
Michael Durrant,

1
Her şeyi kaydedemezsiniz, pratik değil. Neden bazı insanlar yukarıdan aşağıya atlıyorlar ve bazılarının birkaç küçük şeyi günlüğe kaydetmemenin hiç günlüğe kaydetmemek için EŞİT olduğunu düşünerek ???
Darknight

Yanıtlar:


36

Yaptığınız her değişikliği sisteminize kaydetmelisiniz. Olaydan sonra günlüğe kaydetmede yanlış bir şey yoktur - hata raporunu değişiklik numarasına bağladığınız sürece.

Eğer bir şey ters giderse, hatayı takip edebilir ve yaptığınız değişikliği neden yaptığınızı öğrenebilirsiniz .

Vakaların büyük çoğunluğunda haklısınız ve hiç kimse bunlara bir daha bakmayacak, ancak 100'ün 1'inde bir şeyler ters gittiğinde bu bilgi paha biçilmez olacak - özellikle de sorun sadece 6 ay aşağıya çıkıyorsa.

GÜNCELLEŞTİRME

Açıkçası, hala yeni bir özellik geliştiriyorsanız ve bittiğinizi düşündüğünüz özelliğin bir bölümünü keşfederseniz, ayrı bir değişiklik olarak kaydetmeniz gerekmez. Bu durumlarda, ana özelliği isteyen öğeye karşı giriş yapardım.

Özelliğe sahip sistem KG veya müşteriye geçtikten sonra , yukarıda ana hatlarıyla belirtilenleri yapmak gerekir.


Erken geliştirme aşamasında, mühendislik ekibinden ilk sürümü çıkarmadan önce hata izleyicide değişiklikleri kaydetmeye gerek yoktur. Bununla birlikte, değişiklikler her bir gönderime karşı sürüm kontrol kayıtlarında belirtilecektir.
uɐɪ

@ Doğru Bu, ancak genel olarak erken gelişim sırasında (aslında geliştirme ve keşif prototiplemesi yapmadığınız varsayılırsa varsayılır), genellikle bir tür özellik özelliğine karşı çalışacaksınız. Bu durumda, her değişiklik desteklediği özelliklerle bağlantı kurmalıdır. Küçük hata, çizgiyi "bitmiş" bir özelliğe indirir ve bu öğenin desteğini belirtmek için yine de buna bağlanabilir. Bunun, özellikleri ve teknik özellikleri nasıl izlediğinize bağlı olduğunu unutmayın.
CodexArcanum

1
@Darknight - kolay değil! TFS kullandığımızdan ve bununla ilişkili bir iş öğesi olmayan checkin'lere izin vermeyecek şekilde ayarlanmış olmamız bize yardımcı oldu. Evet kuralı geçersiz kılabilirsiniz, ancak durur ve ne yaptığınız hakkında düşünmenizi sağlar.
ChrisF

1
@Darknight Üzgünüz, ama bu sayılar hiçbir şey ifade etmiyor. Bunu söylemek onu doğrulamaz; hepsini doğrulayabilseniz bile, ne olmuş? Bu sayıları sunarak sizlerden alabileceğim tek sonuç, bir şekilde kendini başkalarının üstünde konumlandırmaya çalışmak, açıkçası, gereksiz, gereksiz ve sınırda kaba / saldırgan görünüyor.
casperOne

3
@Tüm sohbet etmek için lütfen bu tartışmayı yapın.
maple_shaft

14

Bir kaynak kontrol aracı kullanıyorsanız, işlem açıklamasında düzelttiğiniz hatayı tanımlayabilirsiniz ve bu, süper küçük, önemsiz hata düzeltmeleri için genellikle yeterli belgelerdir.

Ayrıca, FogBugz ve Kiln gibi kaynak denetiminiz ve depolarınızla tam olarak entegre olan bir hata / özellik izleyici kullanıyorsanız, bu hata düzeltmelerini bulmak ve hangi kodda yaptığınız değişiklikleri görmek için global arama aracını kullanabilirsiniz. kolayca.

Ayrıca, programlama ortağınıza bir kod incelemesi atayabilirsiniz, böylece yaptığınız önemsiz düzeltmeyi gözden geçirebilir, ancak ayrılıyorum ...


1
Evet, bunu yapıyorum. Her ne kadar bazen bir daldayken bazı şeyleri düzelttiğimi ve bunları başka taahhütler içine yerleştirdiğimi buluyorum.
Philip


@ matthieu Bekleyin, Jira SVN ile bütünleşir mi? Aman Tanrım, neden bunu yapmıyoruz? Birkaç eklenti var gibi gözüküyor.
Philip

5

Metrik bakış açısından hala faydalı olabilir.

Bu bilgiler patrona bir çok şeyi göstermek için kullanılabilir:

  • daha fazla geliştiriciye ihtiyacımız var
  • İşlemdeki başka bir şey bozuldu (neden bu kadar çok böcek? diğer adam böceklerin çoğunu üretiyor), belki de size çok fazla böcek olduğunu gösteriyor. Belki buna neden olan bir şey vardır? çok mu serbest bırakıyorsun yeterli test yapılıyor mu?
  • üzerinde çalıştığınız şeylerin iyi bir listesi bonus zamanıdır.

Her şey söyleniyor, bahsettiğiniz bir böcek ne kadar küçük olduğuna bağlıdır. Yeni bir kod eklerken fark ettiğiniz liner'ler, örneğin giriş yapmak için anlamsız olacaktır.


2

Büyüklüğünden bağımsız olarak yaptığım her değişikliği kaydetmeye çalışıyorum. Siz veya bir başkasının (gelecek veya şimdiki zaman) geri dönüp, bu değişimin başka bir şeyin olası nedeni olup olmadığını asla bilemeyeceksiniz.


1

İzleme önemlidir, ancak başka bir senaryoyu da göz önünde bulundurun: inceleme zamanınız geldiğinde. Patronunuzdan hata izleyiciden raporlar alarak resmi olarak şahsen veya gayri resmi olarak orada olacaksınız.

Numaranızı artırmalarını sağlayan 'hile' olarak düşünün. Ne de olsa, onlar sizin giderdiğiniz hatalardır ve önemsiz düzeltmeler olsalar bile onları düzeltmek için tanınmanız gerekir.

Onları kaydet.


Evet, daha büyük kod mağazalarında patronun bundan yola çıkarak “ölçütleri” var, bu yüzden genel bir tavsiye. Ayrıca, izleyiciyi kötüye kullanmaya ve bu metrikleri anlamsız cehenneme atmalarına yol açar. Ama burada sadece ben ve diğer adam. Patron böcek izleyiciyi kullanmıyor.
Philip

1

Buna cevap vermek, bu süreçte nerede olduğunuza bağlıdır.

Bunlar yeni bir proje veya tasarlanan yeni bir özellik için geçerli olabilir.

İlk Tasarım İlk tasarım sırasında yarattığımız koddaki hataları bulursanız, bunun için bir hata izi oluşturmak gerekli olmaz. Değişiklik için ayrı bir taahhüt önereceğim, böylece daha sonra sorun yaşarsanız kolayca çözebilirsiniz.

Test yapmak

Kod her zaman hala ünite testi sırasında hala imkansız kabul edilir, bu yüzden farklı bir grup tarafından yapılmadığı sürece hayır diyeceğim. Ünite testi, bir hata izleyiciden farklı bir grup tarafından yapılırsa, test prosedürünü resmileştirmenin iyi bir yoludur.

CSCI testi bağlıdır. Başka bir grup tarafından mı yapıldı? Eğer öyleyse o zaman evet (yukarıya bakın). Bu, yayınlanmadan önceki testin son adımı mı? Öyleyse evet, çünkü bu noktada yazılımınız olgunlaşmış kabul edilmelidir. Metriklerle ilgileniyorsanız, bu noktada hataları izlemeye başlamak da iyi olacaktır.

Herhangi bir daha yüksek test seviyesi için hata izlemeyi kullanmanız gerekir. Bu noktalarda yazılımınız olgunlaşmış kabul edilmelidir ve izleme hataları önemlidir.

Serbest bırakmak

Her zaman yayınlanan koddaki hataları takip etmelisiniz. Bu hesap verebilirlik için önemlidir.

İhtiyaçlarınıza uygun bir süreci kolaylaştırmak da önemlidir. Gerçekten çok büyük bir hata takip sistemine mi ihtiyacınız var? 2 kişilik bir ekip için tüm alanlar gerçekten bu kadar önemli mi?


1

Belki de dış dünyaya yayımlanan yazılımın daha eski bir sürümünde, başka birisinin hatayla karşılaşması mümkün mü? Öyleyse, hem hatayı hem de düzeltmeyi günlüğe kaydetmek yararlı olabilir.

Diğerleri, hatayı düzeltmek yerine düzeltmek için daha uzun sürerse, kaydetmeye değer olmadığını belirtti. İlgili zaman aralığının hatayı bulmak ve düzeltmek arasında olmadığını, hatanın ortaya çıktığı zaman ile düzeltmenin serbest bırakıldığı zaman arasında olduğunu düşünüyorum.

Değişiklik ve bırakma geçmişi, hatanın gün ışığını hiç görmediğini gösteriyorsa, kaynak kontrolüne girdiğinizde düzeltmeyi günlüğe kaydetmeniz yeterli olacaktır.

Bu, bu soruya oldukça yakın , ancak bunun önemsiz düzeltmelere odaklandığından, bunun yinelendiğinden emin değilim .


1

Neden Jon Arid Torresdal tarafından böcek izlememelisiniz - bunun yerine bunları düzeltin.

  1. Geliştirme sırasında: Bir özellik için bir hatayla karşılaşıyorsunuz; Eğer yapı kırar bir test vakası eklemek , daha sonra özelliği karşı düzeltme kontrol edin.

  2. Serbest bıraktıktan sonra: davranışı belgeleyin . Bir güncelleme yayınlamayı planlıyorsanız, 1. adıma geçin. Bu sürümden sorumlu değilseniz, test + düzeltmeyi özel bir şubede saklayın.

Kod yayınlandıktan sonra başka öncelikler olabilir ve hatayı düzeltmek önemsiz olsa da, sürekli bir dağıtım yapmazsanız düzeltmenin dağıtımı kendi başına ekonomik olmayabilir.


-6

Bağlı nasıl , ben bu tedbiri kullanmak önemsiz:

O alırsa artık o aldı daha bunu günlüğe düzeltmek o, o değil değer o günlüğü.


3
Sadece düzeltmek için oturum açmak daha uzun sürdüğü için yeterli bir gerekçe yoktur. Ha! bu bir açıklama :) vardı
uɐɪ

2
Bunu reddetmedim, ancak neden birinin yaptığını tahmin etmem gerekiyorsa, bunun nedeni tüm hata düzeltmelerini günlüğe kaydetmeye inanmaları ya da cevabınızın çok yararlı / anlayışlı olmadığını düşünmeleridir.
CFL_Jeff

3
Oy kullanmayacağım ama genel bir kural olarak buna katılmıyorum (çoğu durumda bunun mantıklı olduğunu görebildiğim halde). Gönderilen, ancak bir QA ağı üzerinden kaymış "bir hataya karşı" yazsanız ne olur? Bu .... düzeltme daha oturum açmak için uzun sürer
PhillC

2
Eğer günlüğe kaydedilmemişse,
de 26

3
-1 Bu sadece programcı kibir (' olduğunu ben hata yapmam) ve cehalet (ben kötü bir şey küçük düzeltmeler ile gerçekleşmesi görmedim). Gerçekten çok iyi bir kaza ve 'küçük' bir düzeltmeden yakmak genellikle buna yardımcı olur (deneyim olarak da bilinir).
Michael Durrant,
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.