Haruskah pesan commit ditulis dalam bentuk sekarang atau masa lampau? [Tutup]

Jadi mana yang menurut Anda lebih baik dan lebih intuitif?

Fixed the XXX bug in YYY
Fix the XXX bug in YYY
Fixes the XXX bug in YYY
Fixing the XXX bug in YYY

Harap berikan alasan Anda. Catatan Saya bertanya dari perspektif umum Anda, yang berarti Anda tidak boleh mencoba mengasosiasikan ini dengan alat svn / cvs atau bahasa pemrograman pilihan Anda, tetapi menganggapnya sebagai sesuatu yang harus / dapat diterapkan pada alat dan bahasa pemrograman apa pun.

Saya memikirkan pesan-pesan ini seperti yang ditampilkan oleh pengembang lain. Mereka belum menerapkan perubahan, dan ada pertanyaan implisit, "apa yang akan dilakukan dengan menerapkan perubahan / patch ini?" Ini akan "Memperbaiki bug XXX di YYY"!

Untuk kata kerja lain menulisnya sebagai perintah tampaknya lebih alami, dan bekerja lebih baik jika Anda memiliki tujuan tertentu di depan — Anda benar-benar dapat menulis ringkasan komit bersama dengan tes di muka sebelum pekerjaan selesai.

Saya tidak terlalu membebani itu, tetapi bagi saya ini adalah jalan yang paling sedikit perlawanannya sambil mempertahankan konsistensi.

Saya pribadi menggunakan bentuk lampau ("diperbaiki") karena pada saat saya melakukan kesalahan, bug sudah diperbaiki (atau saya tidak akan melakukannya).

Saya lebih suka melihat pesan komit dalam bentuk sekarang. Dengan cara itu pesan menjelaskan apa yang dilakukan oleh diff (karena Anda mungkin menarik diff atau bahkan komit keseluruhan ke dalam cabang yang berbeda). Jadi, pesan komit tidak menjelaskan apa yang "dilakukan" olehnya ... Ini menjelaskan apa yang "dilakukan" oleh komit itu sendiri. Jadi harus dalam bentuk sekarang.

Bayangkan melihat perbedaan dalam isolasi dan mencoba memutuskan apakah Anda akan menerapkannya. Tidak masuk akal untuk memiliki judul dalam bentuk lampau.

IMHO jika Anda ingin deskriptif tanpa perlu mempertimbangkan konteksnya, maka "Fixed" adalah satu-satunya varian yang tepat.

Mengenai intuisi - jika saya melihat beberapa changelog saya pasti akan mengerti bahwa yang Anda maksud bug diperbaiki karena saya tahu konteks di mana kata itu digunakan, tetapi otak saya akan menangkapnya lebih cepat jika kata itu ditulis dalam diri ini- menentukan cara.

"Memperbaiki" adalah pilihan terburuk IMHO karena dapat diartikan tidak hanya sebagai menjelaskan untuk apa tambalan itu (untuk) tetapi sebagai status bug juga yang berarti bahwa itu sedang dikerjakan dan belum dipecahkan.

Fix the XXX bug in YYY
Teach the XXX to be more ZZZ
Correct typos in javadoc

Secara umum: {kata kerja imperatif} {objek yang terpengaruh} {kualifikasi opsional}

Bentuk imperatif cocok untuk semua kasus penggunaan saat saya mempertimbangkan patchset.

• Apa yang akan kamu lakukan disini?
• Apa yang dilakukan patchset ini?
• Mengapa patchset ini dibuat? (untuk memperbaiki bug xxx ...)
• Saya perlu memperbaiki bug xxx pada tahun yyy. Apakah ada komit di cabang lain yang sudah melakukan ini?

Terlepas dari pilihan Anda, saya menemukan konsistensi sangat membantu keterbacaan. Pilih satu dan pertahankan.

Menurut saya, menulis tentang commit saat ini dalam bentuk waktu sekarang adalah ide yang bagus, karena akan lebih jelas jika Anda merujuk ke komitmen sebelumnya di bentuk lampau.

Saya tidak berpikir itu terlalu penting. Tujuannya adalah untuk:

1) Sampaikan apa yang sedang atau sedang dilakukan, sehingga bug lebih mudah ditemukan, masalah dapat dipulihkan dengan lebih mudah, dan umumnya dapat mempertahankan proyek dengan lebih mudah.

2) Sampaikan tiket apa yang telah diperbaiki jika ada, sehingga auditor (jika digunakan di perusahaan Anda dapat melihat perubahan apa yang sesuai dengan tiket mana).

Terakhir, jika 'sudah diperbaiki, "Memperbaiki" tidak masuk akal, dan jika Anda masih mengerjakannya, "Diperbaiki" tidak benar.

" Perbaiki bug X " lebih pendek 2 karakter daripada " Memperbaiki bug X ".
Dan 3 lebih pendek dari " Memperbaiki bug X ".

Dari sudut pandang penulisan-pesan-komit-pendek, bentuk waktu sekarang terkadang / biasanya menyimpan beberapa karakter?
Yang menurut saya penting sedikit, misalnya dengan rekomendasi Git tentang kurang dari 50-karakter-di-baris-komit-pesan-pertama.
Juga, lebih sedikit teks -> selesai membaca lebih cepat?

Pesan komit menjelaskan mengapa Anda menulis kode yang sedang dikomit.

"Memperbaiki masalah 3124", atau "Memperbaiki masalah 3124" tampaknya benar karena dikatakan kode ini diperbaiki | memperbaiki masalah 3124.

Namun, tata bahasanya mungkin juga bergantung pada mengapa menandai bug sebagai diperbaiki. Jika Anda dapat menandai bug sebagai diperbaiki setelah melakukan, maka "Diperbaiki" baik-baik saja, tetapi jika bug akan ditandai sebagai diperbaiki oleh orang lain setelah mereka memverifikasi kode Anda, maka "Perbaikan" mungkin lebih tepat.

Saya pikir jawaban paling penting untuk pertanyaan semacam itu adalah: Setiap orang harus menggunakan apa yang berhasil untuk proyek tertentu dan menjaganya tetap konsisten.

Meskipun saya melihat keuntungan menggunakan present tense (dan sebenarnya tersandung pada posting ini karena saya telah melihat beberapa pesan present tense dalam proyek open source), saya mungkin tidak akan pernah tidak menggunakan present tense untuk proyek saya. Ini adalah cara yang direkomendasikan untuk Linux dan Git, dan mungkin proyek open source lain yang lebih besar, tapi sejujurnya saya tidak peduli selama saya bukan bagian dari proyek ini.

Saya seorang pengembang indie dan saya menggunakan baris pertama dari pesan komit untuk catatan rilis sementara deskripsi di baris berikut memberi saya gambaran tentang detail implementasi. Ini adalah alur kerja yang berpusat pada pengguna dibandingkan dengan pendekatan berbasis pengembang saat ini. Saya bisa menghemat waktu dengan cara ini. Akan sangat tidak wajar untuk memberikan instruksi kepada pengguna saya di catatan rilis. Tugas saya adalah memperbaiki bug dan menambahkan fitur. Saya harus menghemat waktu, karena saya seorang indie. Saya tidak memiliki "penulis catatan rilis" di tim saya.

Gunakan aturan proyek jika sudah ditetapkan, tetapi tetap pragmatis, dan lakukan apa pun yang akan membuat pekerjaan Anda lebih mudah atau lebih cepat.

Saya pikir "Fixes XXX bug"lebih masuk akal daripada "Fix XXX bug"jika alasan menggunakan present tense adalah untuk "membuatnya lebih deskriptif tentang apa yang dilakukan commit" daripada apa yang dilakukan pelaku.

Jika itu adalah komit kecil, saya menggunakan present continuous:

Memperbaiki bug 304

atau

Menambahkan komentar

Jika itu komit besar, saya melakukan lebih banyak perubahan log:

• Memperbaiki Bug 453, 657 dan 324
• Menambahkan sintaks Expression
• Memperbaiki kelas Operator.