Mesej komit adalah kaedah komunikasi penting antara ahli pasukan
Yang paling penting dalam pembangunan perisian pasukan adalah komunikasi. Mesej komit adalah kaedah komunikasi penting antara ahli pasukan: masa lalu dan masa depannya.
Semasa menganalisis kod atau debug, kita semua mempunyai soalan seperti:
- Mengapa ini berlaku jika di sini?
- Siapa yang lupa mengemas kini cawangan?
- Apakah kesan perubahan ini?
- Bagaimana perubahan ini dapat memperbaiki atau memperbaiki kodnya?
Untuk tujuan ini, git-menyalahkan membolehkan kita mengetahui semakan mana yang terakhir mengubah fail. Tetapi hanya mengetahui bahawa itu tidak cukup baik. Akan sangat membantu untuk membaca mesej komit untuk memahami apa yang sebenarnya berlaku di sana.
Kita perlu membaca mesej untuk merasakan nilai sebenar dari pesan komitmen yang baik, dan termotivasi untuk menulisnya.
Beberapa amalan terbaik
Oleh itu, jika sebahagian besar komit Git anda setakat ini telah dibuat dengan sesuatu seperti git commit -m "9000 — Bug fixes issue"itu, kemudian cuba garis panduan ini:
-m
sg&
gt; / --message=
gt; flag t
Ini memberi Anda pola pikir yang buruk langsung dari kelelawar kerana anda akan merasakan bahawa anda harus memasukkan pesan komit anda ke dalam perintah terminal, dan membuat komit merasa lebih seperti hujah satu kali daripada halaman dalam sejarah.
Baris pertama hendaklah selalu 50 aksara atau kurang dan harus diikuti dengan garis kosong.Tuliskan ketegangan penting: "Perbaiki pepijat". [ Tambah | Betulkan | Keluarkan | Kemas kini | Refactor ] Kata-kata yang konsisten menjadikannya lebih mudah untuk memproses senarai komited secara mental.
72 aksara dibungkus dengan keterangan lebih panjang.Selalunya subjek dengan sendirinya mencukupi.Sekiranya tidak, tambahkan baris kosong (ini penting) diikuti oleh satu atau lebih perenggan yang dibungkus dengan 72 aksara.
Perenggan tersebut harus menjelaskan:
Mengapa perubahan ini diperlukan?
Jawapan ini menjelaskan apa yang diharapkan dalam komitmen, yang membolehkan mereka mengenal pasti dan menunjukkan perubahan yang tidak berkaitan dengan lebih mudah.
Bagaimana ia menangani masalah tersebut?
Huraikan, pada tahap tinggi, apa yang dilakukan untuk mempengaruhi perubahan. Sekiranya perubahan anda jelas, anda mungkin tidak dapat menjawab soalan ini.
Apakah kesan sampingan perubahan ini?
Ini adalah soalan yang paling penting untuk dijawab, kerana dapat menunjukkan masalah di mana anda membuat terlalu banyak perubahan dalam satu komitmen atau cabang. Satu atau dua titik peluru untuk perubahan berkaitan mungkin baik, tetapi lima atau enam kemungkinan merupakan petunjuk komitmen yang melakukan terlalu banyak perkara.
# 50-character subject line## 72-character wrapped longer description. This should answer:## * Why was this change necessary?# * How does it address the problem?# * Are there any side effects?## Include a link to the ticket, if any.Bagaimana menjadikan hidup anda lebih mudah
Banyak yang perlu diingat, tetapi anda boleh menyediakan templat pesanan komit dengan menggunakan commit.template
Konfigurasikan Git untuk menggunakan fail templat (misalnya, .gitmessage), kemudian buat fail templat dengan Vim:
git config --global commit.template ~/.gitmessagevim ~/.gitmessageApabila kita berjalan git committanpa -mbendera mesej, editor akan membuka templat bermanfaat kita yang siap sedia:
# [Add/Fix/Remove/Update/Refactor/Document] [summary]# Why is it necessary? (Bug fix, feature, improvements?)-# How does the change address the issue? -# What side effects does this change have?-# Include a link to the ticket, if any.Garis komen tidak termasuk dalam mesej terakhir. Cukup isi baris kosong dengan teks dan titik peluru di bawah arahan.
Penjejak isu di GitHub dan Bitbucket kedua-dua mengiktiraf kata kunci close, fixdan resolvediikuti dengan segera oleh isu atau tarik jumlah permintaan.
Saya fikir Linus akan sangat gembira jika kita tidak lagi menggunakan git commit -m "Fix bug"repositori awam :)
Anda boleh mencari dengan mudah di log git untuk mendapatkan nombor masalah, misalnya git log --grep=JIRA-1234
Anda juga boleh menggunakan plugin seperti vim-fugitiveuntuk VIM atau git lensuntuk vs kod untuk cepat akses kepada git melakukan mesej.
Menutup fikiran
Membuat bersih Git komited mengatakan banyak perkara tentang anda dan mungkin cara utama orang berinteraksi dengan anda melalui projek.
Dengan sedikit latihan, anda dapat menjadikan tabiat berkomitmen anda sebagai cerminan kerja terbaik anda - karya yang jelas dibuat dengan penuh perhatian dan bangga.
Masa depan anda, anda dan pasukan anda, akan mengucapkan terima kasih atas pemikiran dan kefasihan anda ketika mereka git blameberusaha untuk mengetahui mengapa syarat itu ada.
Sekiranya anda menikmati artikel ini, sila tepuk tangan, cadangkan dan kongsi.