Mulai pesan git commit dengan tanda pagar (#)

Git memperlakukan baris yang dimulai dengan #sebagai baris komentar ketika melakukan. ini sangat menjengkelkan ketika bekerja dengan sistem pelacakan tiket, dan mencoba menulis nomor tiket di awal baris, misalnya

#123 salt hashed passwords

git hanya akan menghapus baris dari pesan komit. apakah ada cara untuk menghindari hash? saya mencoba \dan !, tetapi tidak ada yang berhasil. spasi putih sebelumnya #dilestarikan, jadi itu juga bukan solusi yang baik untuk masalah tersebut.

Perilaku ini adalah bagian dari perilaku git commit'pembersihan' default. Jika Anda ingin menjaga garis mulai dari# Anda dapat menggunakan mode pembersihan alternatif.

Misalnya

git commit --cleanup=whitespace

Jika Anda melakukan ini, Anda harus berhati-hati untuk menghapus semua #baris yang Anda tidak ingin muncul di komit.

Perhatikan bahwa, sejak git1.8.2 (Februari 2013) , Anda dapat menggunakan karakter yang berbeda dari ' #' untuk baris yang dikomentari dalam pesan komit.

Itu memungkinkan Anda menggunakan ' #' untuk referensi nomor bug Anda.

Berbagai baris "petunjuk" yang diberikan Git ketika meminta pengguna untuk mengedit pesan di editor dikomentari dengan ' #' secara default.

The core.commentCharvariabel konfigurasi dapat digunakan untuk menyesuaikan 'ini #' untuk karakter yang berbeda.

Secara teori, Anda bisa meletakkan core.commentCharkata (banyak karakter), tetapi git 2.0.x / 2.1 akan lebih ketat (Q3 2014).

Lihat commit 50b54fd oleh Nguyễn Thái Ngọc Duy ( pclouds) :

config: ketat pada core.commentChar

Kami tidak mendukung string komentar (setidaknya belum). Dan pengkodean karakter multi-byte juga bisa disalahartikan.

Tes dengan dua koma diperbarui karena melanggar ini. Itu ditambahkan dengan tambalan yang memperkenalkan core.commentChardi eff80a9 (Izinkan custom "comment char" - 2013-01-16). Tidak jelas bagi saya mengapa perilaku itu diinginkan.

git 2.0.x / 2.1 (Q3 2014) akan menambahkan pilihan otomatis untuk core.commentChar:
Lihat commit 84c9dc2

Ketika core.commentChar" auto", char komentar dimulai dengan ' #' sebagai default tetapi jika sudah dalam pesan yang disiapkan, cari char lain di subset kecil. Ini harus menghentikan kejutan karena git menghapus beberapa baris secara tidak terduga.

Perhatikan bahwa git tidak cukup pintar untuk mengenali ' #' sebagai karakter komentar di template khusus dan mengonversinya jika karakter komentar akhir berbeda.
Ia menganggap baris '#' dalam templat khusus sebagai bagian dari pesan komit. Jadi jangan gunakan ini dengan template khusus.

Daftar karakter kandidat untuk "otomatis" adalah:

# ; @ ! $ % ^ & | :

Itu berarti perintah seperti git commit -m '#1 fixed issue'akan secara otomatis mengalihkan commentChar ke ' ;', karena ' #' digunakan dalam pesan komit.

Jawaban di sini bagus dan terperinci, tetapi untuk git noob seperti saya menyesuaikan opsi konfigurasi git tidak begitu jelas. Berikut adalah contoh untuk mengubah dari #ke ;untuk karakter komentar:

git config core.commentChar ";"

Itu semua yang perlu Anda lakukan.

Anda dapat menggunakan opsi baris perintah -m:

git commit -m "#123 fixed"

Jika Anda melakukan rebase interaktif, maka ketika Anda menyimpan pesan komit Anda tanpa isi di dalamnya (karena #pada awalnya telah memberikan komentar dan karenanya diabaikan) git akan menunjukkan kepada Anda apa yang harus dilakukan:

Aborting commit due to empty commit message.
Could not amend commit after successfully picking 5e9159d9ce3a5c3c87a4fb7932fda4e53c7891db... 123 salt hashed passwords
This is most likely due to an empty commit message, or the pre-commit hook
failed. If the pre-commit hook failed, you may need to resolve the issue before
you are able to reword the commit.
You can amend the commit now, with

        git commit --amend

Once you are satisfied with your changes, run

        git rebase --continue

Jadi, ubah saja pesannya:

git commit --amend -m "#123 salt hashed passwords"

dan lanjutkan rebase:

git rebase --continue

git commit --cleanup=scissorsseharusnya digunakan. Ini ditambahkan ke Git v2.0.0 pada 2014.05.21

dari git commit --help

--cleanup=<mode>
  scissors
    Same as whitespace, except that everything from (and including) the line
    "# ------------------------ >8 ------------------------" is truncated if the message
    is to be edited. "#" can be customized with core.commentChar.

Gunakan awalan berbeda untuk nomor tiket. Atau tambahkan kata ke nomor tiket, seperti "Bug # 42". Atau tambahkan satu karakter spasi ke baris; jika Anda ingin menghapus spasi itu, Anda dapat menambahkan komit-kait untuk itu.

Saya pribadi lebih suka tidak melakukan manipulasi pesan komit semacam ini dilakukan oleh sebuah pengait karena bisa sangat menjengkelkan ketika dipicu ketika Anda tidak menginginkannya. Solusi termudah mungkin adalah memikirkan kembali masalahnya.

Semua komit saya dimulai dengan #issueNumberjadi saya menempatkan boilerplate ini ke vim .git/hooks/commit-msg:

NAME=$(git branch | grep '*' | sed 's/* //') 
echo "$NAME"' '$(cat "$1") > "$1"

Jadi anggaplah kita memiliki cabang #15dan kita membuat pesan komit add new awesome feature. Dengan pendekatan ini pesan komit akhir akan #15 add new awesome feature.