SORU
4 EYLÜL 2008, PERŞEMBE


Taahhüt iyi bir mesaj için öneriler: biçim/kılavuz?

Yeni bir projenin başında ben varım ve akıllı bir şekilde depo kurmak ve kod üzerinde konsantre olması herkes için bazı kod tarzı kurallar kurmaya çalışıyorum.

Çoğu bitti, ama hala iletileri işlemek için uygulanması gereken biçimi hakkında emin değilim. Özgürlük ve insanlar onları açık ve kapsamlı yapmak için söylüyorum sadece ben varım, ama bu nadiren işe yaradığı var, insanlar çok farklı fikirlere sahip olmanın "":).

Ve şimdiye kadar, hiçbir zaman tatmin edici bir plan buldum. Ben çoğu zaman ne olduğunu: tamamlama, mermi noktaları sonra tek satırlık bir özet daha ayrıntılı olarak her bir değişikliği anlatır.

Ama genellikle özellikleri, dosya, ya da küçük/büyük değişiklikler uygun görünüyor tarafından zor bir kurşun nokta hak ettiğini ve ve sınıflandırma bir tür değil ne karar verecek. Ne yazık ki her zaman, yazarken buluyorum ben öyle yaparım aptalca uzun önemsiz değişiklikler için mesaj kaydetme...

Bunu nasıl yapıyorsun?

CEVAP
4 EYLÜL 2008, PERŞEMBE


Aslında kendileri için düşünmek için güçlü olmak insanlara güvenmek olduğunu düşünüyorum. Bazı Temel Kurallar, özetlenen olanlar gibi sağlayabilir, ama sonunda insanlar onları takip etmek için onları anlamak gerekir.

İşte bir my recommended best practices for version control özü:

Depo için bir şey yapılıyor, her zaman bir yorum yazmak. Yorum kısa ve öz, nelerin değiştiğini ve neden açıklayan olmalıdır. Eğer birkaç değişiklik yaptıysanız, her bölümle ilgili bir satır veya cümle yazın. Eğer bir değişiklik olursa çok uzun bir liste yazmaya kendinizi bulursanız, daha önce açıklandığı gibi küçük parçalara taahhüt bölme düşünün. Düzeltme ya da Eklemek gibi tanımlayıcıları ile yorum başına mı yaptığını gösteren iyi bir yoldur. Aynı zamanda daha kolay içerik daha sonra da görsel olarak, insan bir okuyucu, ya da otomatik olarak bir program tarafından filtre için yapar.

Belirli bir böcek sabit veya belirli bir değişiklik isteği uygulandığı takdirde, ben de hata ya da sorun Mesaj Sayısı tamamlama başvuru öneririm. Bazı araçlar bu Bilgi İşlem ve hata takip sisteminde ilgili sayfaya bir bağlantı oluşturmak veya otomatik olarak konu tamamlama dayalı güncelleyebilir.

Burada iyi örnekler mesajları kaydetme:

Changed paragraph separation from indentation to vertical space.
    ...
    Fix: Extra image removed.
    Fix: CSS patched to give better results when embedded in javadoc.
    Add: A javadoc {@link} tag in the lyx, just to show it's possible.
    ...
    - Moved third party projects to ext folder.
    - Added lib folder for binary library files.
    ...
    Fix: Fixed bug #1938.
    Add: Implemented change request #39381.

Benim durumumda, insanları takip etmek, onları kuralları işlemeye takip etmiyorlar her yön vermelisin. Elbette bazı kuralları uygulamak için bir komut dosyası uygulamak olabilir (önek ve bug başvuru gibi), ama hiçbir şey anlamlı yazma zahmetine girmeyen tembel insanları yakalamak değil. Önemli olan bu kuralları neden istediğini ve geliştirme ekibi nasıl yararlanacaktır açıklamak için olduğunu düşünüyorum.

E-posta listesi taahhüt ve mesaj için bir monitör ayarlama ne insanların ne yaptığını takip etmek için iyi bir yoldur. Birisi tatmin edici bir mesaj olmadan bir şey işlediği zaman, çok bilir ve söyler. Onları başarılı olmak için kuralları kodlama ile, birileri onları takip etti aynı şekilde sanırım.

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

YORUMLAR

SPONSOR VİDEO

Rastgele Yazarlar

  • Bennythecoder

    Bennythecode

    25 Mart 2008
  • PCDIY

    PCDIY

    16 AĞUSTOS 2013
  • sinumatic

    sinumatic

    19 Aralık 2006