Apakah referensi bug / masalah dalam pesan komit dianggap praktik yang baik?

11

Saya sedang mengerjakan sebuah proyek di mana kami memiliki kontrol sumber diatur untuk secara otomatis menulis catatan di pelacak bug. Kami cukup menulis ID masalah bug dalam pesan komit dan pesan komit ditambahkan sebagai catatan untuk pelacak bug.

Saya hanya dapat melihat beberapa kerugian untuk praktik ini. Jika suatu saat nanti kode sumber dipisahkan dari perangkat lunak pelacakan bug (atau bug / masalah yang dilaporkan entah bagaimana hilang). Atau ketika seseorang mencari dalam sejarah commit, tetapi tidak memiliki akses ke pelacak bug kami.

Pertanyaan saya adalah apakah memiliki referensi bug / masalah dalam pesan komit dianggap praktik yang baik? Apakah ada beberapa kerugian lainnya?

programming-practices version-control issue-tracking Christian P
sumber

Jawaban:

10

Kami telah mengadopsi praktik ini dan itu sangat baik bagi kami. Integrasi yang ketat antara sistem kontrol versi (VCS) dan sistem lain yang kami gunakan, misalnya integrasi berkelanjutan, pelacak bug, dll. Sangat berharga. Jika kami pernah mengubah apa pun di masa depan, kami tentu harus menilai efek sampingnya, termasuk tautan antara VCS dan sistem pelacakan bug.

Secara umum saya akan melihat ini sebagai praktik yang baik. Untuk beberapa sistem pelacakan ada opsi dan alat tambahan yang tersedia, misalnya properti bugtraq untuk Subversion (SVN). Ini menunjukkan bahwa beberapa orang melihat nilai dalam praktik ini.

Manfred
sumber
13

Jika Anda ingin benar-benar yakin bahwa tidak ada informasi yang hilang bahkan jika Anda dapat menggunakan pelacak bug yang berbeda di masa depan atau data pelacak bug Anda entah bagaimana menghilang, mengapa tidak memasukkan ID masalah dan penjelasan singkat tentang bug ke dalam pesan komit?

Perbaiki bug # 123: aplikasi macet setelah masuk

Maka Anda masih memiliki tautan dari riwayat komit ke pelacak bug - dan jika pelacak bug seharusnya tidak tersedia, Anda masih dapat melihat dalam sejarah tentang bug khusus ini.

Christian Specht
sumber
Kami benar-benar melakukan itu, jadi kami tidak perlu beralih ke pelacak bug setiap kali kami menelusuri riwayat komit.
Christian P
Oke, kalau begitu aku akan membiarkannya apa adanya. IMO, ini adalah cara terbaik untuk melakukannya!
Christian Specht
1
Ya, poin bagus. Bagaimanapun, itu adalah asumsi saya. Hanya ID bug / masalah saja tidak cukup baik dalam pengalaman saya. Melihat log komit, Anda masih ingin melihat apa yang masing-masing komit, misalnya apa alasan luas untuk perubahan kode ini. Terkadang pesan komit lebih pada sisi teknis sementara teks untuk sistem pelacakan bug lebih diarahkan pada pengguna perangkat lunak.
Manfred
Ini umumnya merupakan praktik standar di mana saya telah bekerja juga, saya pikir itu cara yang tepat untuk melakukannya.
Carson63000
+1 selalu melakukan ini! Saya baru saja mengambil pemeliharaan proyek yang dipenuhi permata seperti "ini mungkin penyebab bug 5423" Kami tidak memiliki akses ke pelacak bug mereka.
Kryptic
2

Ini adalah praktik yang sangat umum, dan saya merasa sangat nyaman. Saya menggunakan TRAC, jadi saya bisa membaca riwayat kode dan menavigasi ke tugas yang mendorong perubahan, atau membaca riwayat tugas dan menavigasi ke perubahan kode.

"Jika suatu saat nanti ..." Jika Anda memisahkan kode dari pelacak kutu, maka riwayat revisi yang lama mungkin tidak akan menarik.

kevin cline
sumber
2

Saya menggunakan latihan ini juga dan saya menganggapnya sangat bagus. Tapi selain ID masalah, saya menambahkan deskripsi singkat tentang bug / fitur (biasanya judul dari sistem pelacakan bug). Ini sering membantu menghemat waktu karena saya tidak perlu mencari di sistem pelacakan bug (karena saya mengenali perubahan) DAN, seperti yang Anda katakan, jika entah bagaimana saya kehilangan sistem pelacakan bug, saya tidak sepenuhnya hilang.

Nicolae Albu
sumber