Küçük hata düzeltmeleri ve küçük özellikler için hangisi daha iyidir - şubeleri bilet numarasına göre adlandırmak veya özellik açıklamasına göre adlandırmak?

Uygun şube adlandırma konusundaki liderliğimle bir anlaşmazlığın ortasındayım (elbette samimi). Bu, uzun süren özellik dalları için değil, hata düzeltme ve küçük özellik dalları için geçerlidir. Uzun süren özellik dalları için, insan tarafından okunabilen adların daha iyi olduğunu kabul ediyoruz. İşte iki bakış açısı:

Benim:

Şubeleri takımlarına ve bilet numaralarına göre adlandırmak daha iyidir. Bunları biletleme sistemimizde bulmayı kolaylaştırır ve yazım süresini kısaltır. Ayrıca, bir bilet hakkında geçmiş bilgileri ararken GIT'deki ilgili şubeleri aramayı kolaylaştırır.

Misal:

team-name/12345
team-name/53719

His:

Şubeleri özelliklerine / işlevlerine göre adlandırma. Otomatik tamamlamayı kolaylaştırır ve hatırlanması bireysel numaralardan daha kolaydır.

Misal:

team-name/fix-that-sql-bug
team-name/expand-http-parser

Sunduğum bir uzlaşma şudur:

team-name/12345-fix-that-sql-bug

Ancak GIT otomatik tamamlamasıyla uğraştığı için bunu sevmiyor.

Bu öncelikle görüşe dayalıysa, lütfen bunun SO için daha uygun olabileceği konusunda bana rehberlik etmekten çekinmeyin - ancak verdiğim nedenlerin ampirik bir cevap vermek için değiştirilebileceğini / eklenebileceğini düşünüyorum.

Bu durumda, hem numaraya hem de açıklamaya sahip bir adlandırma kuralından ödün verebileceğiniz anlaşılıyor:

Misal:

takım ismi / (12345) fix-o-sql-böcek

takım ismi / (53719) -genişletin-http-ayrıştırıcı

Burada gerçekten doğru bir cevap yok, bakış açınıza bağlı olarak özneldir.

Ama ikiniz de uzlaşırsanız, her iki dünyanın da en iyisini elde edersiniz. Ekibimde benzer anlaşmazlıklar yaşadığımızda bunu akılda tutmaya çalışıyorum.

Düzenle:

Otomatik tamamlama sorunuyla başa çıkmak için numaralandırılmış kimliği parantez içine alabilirsiniz, böylece her zaman yazdığınız bir dalı yazdığınızda (dalları görmek için. Bu listeden numaralı kimliği ve açıklamayı görebilirsiniz. Sadece birkaç sayı, sekme girin ve

Herkesin kabul ettiği ve anladığı tutarlı bir sistem olduğu sürece gerçekten önemli değil.

Yine de, bilet numarasına gitmenin, hangi dalın üzerinde çalışılacağını hatırlamayı kolaylaştıracağını söyleyebilirim. Bir açıklama yerine doğrudan sayıya bağlandıkları için. Sadece açıklama yapmak, hangi belirli sorunun olması gerektiğini hatırlamayı zorlaştırıyor gibi görünüyor ve belirsiz olmaktan kaçınmaya çalışırken uzun süre sarılmış olabilir.

team-name/bug-that-has-specific-circumstances-to-occur-and-takes-alot-to-describe

Yalnızca otomatik tamamlamadan yararlanmak için bir şeyi adlandırmak aptalca.

Böcek izleyiciye bir bağlantının önemli olduğunu kabul ediyorum (iyi bir isimden daha önemlidir, çünkü birkaç kelimenin çözmediği dal tarafından çözülen problemi tam olarak tanımlar) ama aynı zamanda insanları beklemek için bir kullanılabilirlik hatası # 7312 ve # 7213 arasındaki farkı bilmek. Ayrıca, insanların her seferinde rakamları mükemmel bir şekilde almasını beklemek başarısız - bir gün biri yanlış şubeye bağlı olacak çünkü 7213 için 7312'yi yanlış okudular / yanlış yazdılar. (Ekibimdeki biri bugün yaptı!)

Her ikisini de yapın - şubeyi numaralandırın ve sadece çek olarak davranmak için çok kısa bir metin açıklaması ekleyin. Yine de şubenin metnini (örn. "Sunucu için bug-fix-" veya "sunucu için düzeltme-bug-bug") bilmek zorunda olduğunuz için, numarayı ilk sıraya koyarım - otomatik tamamlama - lanetlenmiş - hala bilmeniz gerekir f veya b ile başlıyorsa!)