Pesan commit
Pesan commit yang jelas membuat permintaan pull lebih mudah ditinjau, dan catatan rilis lebih mudah dibuat. Project Blockly menggunakan commit konvensional untuk membantu mengatasi hal ini.
Setiap commit harus memiliki format:
<type>: <description>
[optional body]
[optional footer(s)]
Perhatikan bahwa repo Blockly inti memiliki linter commit untuk membantu menerapkannya. Jika permintaan pull Anda memiliki beberapa commit, linter akan memeriksa judulnya. Jika memiliki satu commit, fungsi ini akan memeriksa commit tersebut. Sebaiknya setiap commit dan judul permintaan pull mengikuti panduan ini.
Jenis
Jenis tidak boleh kosong, dan semua huruf kecil. Berikut adalah daftar jenis yang diterima.
- pekerjaan rumah
- 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.
- lepaskan
- Untuk commit yang terkait dengan rilis versi baru.
Perubahan yang dapat menyebabkan gangguan
Commit yang membuat perubahan yang dapat menyebabkan gangguan harus menambahkan ! setelah jenis
commit. Perubahan yang dapat menyebabkan gangguan adalah perubahan yang dapat mengganggu developer yang menggunakan Blockly di
aplikasi mereka, sehingga mereka harus melakukan pekerjaan ekstra.
Contoh:
fix!: return type of workspace.paste
Perubahan yang dapat menyebabkan gangguan dapat memiliki salah satu jenis valid di atas.
Deskripsi
Deskripsi tidak boleh kosong, dan harus kurang dari 256 karakter.
Body
Isi bersifat opsional. Jika diberikan, harus ada baris kosong antara deskripsi dan deskripsi. Deskripsi harus dipecah menjadi baris yang tidak lebih dari 256 karakter.
Perhatikan bahwa biasanya, disarankan untuk menempatkan informasi semacam ini dalam deskripsi permintaan pull, selain/bukan secara langsung di commit.
Footer
Footer bersifat opsional. Jika diberikan, harus ada baris kosong antara isi dan isi. Deskripsi harus dipecah 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 tersebut, bergantung pada jumlah commit yang Anda miliki:
Jika permintaan pull Anda memiliki beberapa commit, edit judul permintaan pull agar sesuai dengan persyaratan. Saat permintaan pull digabungkan, commit lainnya akan digabungkan sehingga judul menjadi pesan commit.
Jika permintaan pull Anda memiliki satu commit, ubah pesan commit menggunakan
git commit --amend, lalu kirimkan perubahan secara paksa ke fork Blockly. Tindakan ini akan otomatis memperbarui setiap permintaan pull terbuka yang terkait dengan cabang ini.git push --force origin my-branch.