Commit Messages

This post is available in 2 languages: id en

Pengenalan

Sebagai praktik yang baik, pesan commit harus dapat menyampaikan maksud dari commit tersebut secara singkat. Hal ini sangat penting untuk memudahkan developer lain mengerti maksud commit dengan hanya melihat pesan commit anda, yang akan membuat mengetahui file mana yang telah diubah lebih mudah. Jika anda tidak bisa merangkum perubahan yang dilakukan dengan mudah maka bisa jadi commit tersebut dapat dipisahkan menjadi beberapa commit yang lebih kecil. Untuk commit yang bertujuan memperbaiki isu yang tertera pada list isu repositori, anda juga harus mencantumkan nomor isu tersebut (lihat disini).

Intro

As a good practice, commit messages have to be descriptive of what the commit is doing yet concise at the same time. It is important so that other developers will get the gist of your commit just by looking at your commit message, hence make inferring which files has changed easier. If you can't summarise your changes easily chances are you need to break them down into smaller commits. For commits that fix issues from the repository issues list, you also need to reference the issue number (see here).

Here are some examples from a few open source software commit messages: