SORU
18 ŞUBAT 2010, PERŞEMBE


Gıt Mesaj Kaydetme : 50/72 Biçimlendirme

Tim Pope belirli bir git blog görevinden mesaj tarzı işlemek için savunuyor: http://www.tpope.net/node/106

Burada ne tavsiye edecek kısa bir özeti:

  • İlk satır 50 karakter veya daha az
  • Boş bir satır sonra
  • Kalan metin 72 karakter paket yapılır

Blog görevinden bu öneriler için gerekçe verir ararım ("" için kısaltma) 50/72 biçimlendirme:

  • Uygulamada, bazı araçlar bir konu satırı ve bir organ olarak, ikinci paragraf (e-posta benzer) olarak ilk satırı tedavi
  • git log Ambalaj işlemez, sabit hatları çok uzun okumak.
  • 4* *dönüştürür -- Yani eğer zaten güzel sarılır yaparsa yardımcı olur iyi oynamak için e-posta kaydeder.
  • Tim ile aynı fikirde olacağını düşünüyorum eklemek istediğim bir nokta: eğer kaydetme özetleme eylemi iyi bir uygulama doğal olarak herhangi bir sürüm kontrol sistemi. Diğerleri (veya bir sonraki) ilgili daha hızlı işliyor bulmanıza yardımcı olur.

Yani, benim soru için parçaları bir çift sözüm var:

  • Ne varsa alırım (kabaca) 'düşünce liderleri' veya 'tecrübeli kullanıcılar' git 50/72 biçimlendirme tarzı benimsiyorsun? Bazen yeni kullanıcılar bilmiyor veya topluluk uygulamaları hakkında umurumda değil çünkü bu sorun.
  • Bu biçimlendirme kullanmayın olanlar için, farklı bir biçimlendirme stili kullanmak için ilkeli bir nedeni var mı? (Lütfen esasına ilişkin bir tartışma arıyorum unutmayın, "hiç duymadım" ya da "umurumda değil").
  • Deneysel olarak konuşursak, yüzde kaçı git depoları bu tarz kucaklamak? Birisi GitHub depoları üzerinde bir analiz yapmak isterse diye (... ipucu, ipucu.)

Burada benim amacım 50/72 tarzı tavsiye veya diğer stilleri vurmak için değil. (Bu konuda açık olmak, bunu tercih ederim, ama başka fikirlere açığım.) Ben sadece insanların veya çeşitli gıt gibi karşı neden gerekçesi taahhüt mesaj stilleri almak istiyorum. (Sözü henüz puan getirmek için çekinmeyin.)

CEVAP
16 AĞUSTOS 2012, PERŞEMBE


İlgili "Özet" line (formülde 50), the Linux kernel documentation has this to say:

For these reasons, the "summary" must be no more than 70-75
characters, and it must describe both what the patch changes, as well
as why the patch might be necessary.  It is challenging to be both
succinct and descriptive, but that is what a well-written summary
should do.

Bu, çekirdek bakıcıları, gerçekten 50 civarında tutmaya çalışın gibi görünüyor. " dedi. İşte çekirdek için git günlüğüne Özet çizgilerin uzunlukları histogram

Lengths of git summary lines (view full-sized)

Bu arsa ilginç kısmı tek bir çizgi gibi görünür olmadan tutabilir daha uzun (çok uzun) Özet hatları olan taahhüt çat Pat var. (Muhtemelen bu verileri burada eklemek için süslü bir istatistik tekniği var ama neyse... :) ).

Eğer ham uzunlukları görmek isterseniz:

cd /path/to/repo
git shortlog  | grep -e '^      ' | sed 's/[[:space:]]\ \(.*\)$/\1/' | awk '{print length($0)}'

ya bir metin tabanlı histogram:

cd /path/to/repo
git shortlog  | grep -e '^      ' | sed 's/[[:space:]]\ \(.*\)$/\1/' | awk '{lens[length($0)]  ;} END {for (len in lens) print len, lens[len] }' | sort -n

Bunu Paylaş:
  • Google+
  • E-Posta
Etiketler:
Git

YORUMLAR

SPONSOR VİDEO

Rastgele Yazarlar

  • Cartoonium

    Cartoonium

    11 NİSAN 2011
  • Cristina Landa

    Cristina Lan

    28 Ocak 2010
  • IGN

    IGN

    19 EYLÜL 2006