Pesan commit
Pesan commit yang jelas mempermudah peninjauan permintaan pull, dan memudahkan pembuatan catatan rilis. Project Blockly menggunakan conventional commits untuk membantu hal ini.
Setiap commit harus memiliki format:
<type>: <description>
[optional body]
[optional footer(s)]
Perhatikan bahwa repo Blockly inti memiliki linter commit untuk membantu menerapkan hal ini. Jika pull request Anda memiliki beberapa commit, linter akan memeriksa judulnya. Jika memiliki satu commit, commit tersebut akan diperiksa. Sebaiknya commit individual dan judul pull request Anda mengikuti panduan ini.
Jenis
Jenis tidak boleh kosong, dan semua huruf kecil. Berikut adalah daftar jenis yang diterima.
chore: Untuk commit yang menyelesaikan tugas rutin/otomatis seperti mengupgrade dependensi.deprecate: Untuk commit yang menghentikan penggunaan fungsi.feat: Untuk commit yang menambahkan fungsi baru ke Blockly.fix: Untuk commit yang memperbaiki bug/error di Blockly.release: Untuk commit yang terkait dengan rilis versi baru.
Perubahan yang dapat menyebabkan gangguan
Penerapan yang membuat perubahan yang dapat menyebabkan gangguan harus menambahkan ! setelah jenis penerapan. Perubahan yang menyebabkan gangguan adalah perubahan yang dapat mengganggu developer yang menggunakan Blockly di aplikasi mereka, sehingga mereka harus melakukan pekerjaan tambahan.
Contoh:
none
fix!: return type of workspace.paste
Perubahan yang menyebabkan gangguan dapat memiliki salah satu jenis yang valid di atas.
Deskripsi
Deskripsi tidak boleh kosong, dan tidak boleh lebih dari 256 karakter.
Isi
Isi bersifat opsional. Jika disediakan, harus ada baris kosong di antara judul dan deskripsi. Teks harus dibagi menjadi baris yang tidak lebih dari 256 karakter.
Perhatikan bahwa biasanya, sebaiknya masukkan informasi semacam ini dalam deskripsi permintaan penarikan Anda, selain/daripada langsung dalam commit.
Footer
Footer bersifat opsional. Jika disediakan, harus ada baris kosong di antara baris tersebut dan isi. Teks harus dibagi menjadi baris yang tidak lebih dari 256 karakter.
Memperbaiki commit non-konvensional
Jika Anda tidak menggunakan commit konvensional saat melakukan modifikasi, ada dua opsi untuk memperbaiki pesan, bergantung pada jumlah commit yang Anda miliki:
Jika permintaan pull Anda memiliki beberapa commit, edit judul permintaan pull agar sesuai dengan persyaratan. Saat permintaan penarikan digabungkan, commit Anda yang lain akan digabungkan sehingga judulnya menjadi pesan commit.
Jika pull request Anda memiliki satu commit, ubah pesan commit Anda menggunakan
git commit --amend, lalu lakukan push paksa perubahan Anda ke fork Blockly Anda. Tindakan ini akan otomatis memperbarui semua permintaan penarikan terbuka yang terkait dengan cabang ini.git push --force origin my-branch.