Writing good commit messages

來源:互聯網
上載者:User

The author of Pro Git
(an excellent online book) gives this advice for commit messages:



Getting in the habit of creating quality commit messages makes using
and collaborating with Git a lot easier. As a general rule, your
messages should start with a single line that's no more than about 50
characters and that describes the changeset concisely, followed by a
blank line, followed by a more detailed explanation. The Git project
requires that the more detailed explanation include your motivation for
the change and contrast its implementation with previous behavior —
this is a good guideline to follow. It's also a good idea to use the
imperative present tense in these messages. In other words, use
commands. Instead of "I added tests for" or "Adding tests for," use
"Add tests for." Here is a template originally written by Tim Pope at
tpope.net:



Short (50 chars or less) summary of changes

 

More detailed explanatory text, if necessary.  Wrap it to about 72 characters or so.  In some contexts, the first line is treated as the
subject of an email and the rest of the text as the body.  The blank line separating the summary from the body is critical (unless you
omit the body entirely); tools like rebase can get confused if you run the two together.

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded by a single space, with blank lines in between, but conventions vary here

If all your commit messages look like this, things will be a lot easier for you and the developers you work with.  The Git project has well-formatted commit messages — I encourage you to run git log --no-merges there to see what a nicely formatted project-commit history looks like.

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.