How to write good message submission

ArticleDirectory

• Writing good commit messages

Writing good commit messages

 

Good commit messages serve at least three important purposes:

Good message submission serves at least three important purposes:

• To speed up the reviewing process.
• AccelerationCodeReview process.

• To help us write a good release note.
• Help us to write a good version description.

• To help the future maintainers of Erlang/OTP (it cocould be you !), Say five years into the future, to find out why a particle change was made to the Code or why a specific feature was added.
• Help Erlang/OPT maintainers (maybe you) in the future. In the next five years, find out why the Code has made a special change or added a specific feature.

Structure your commit message like this:

The structure of the information you submit is as follows:

Summarize clearly in one line what the commit is about summarizes what is submitted in one sentence. Describe the problem the commit solves or the usecase for a new feature. justify why you chosethe particle solution. describes the problem to be submitted or the new use case. Demonstrate why you chose this specific solution.
 

Do

• Write the summary line and description of what you have done in the imperative mode, that is as if you were commanding someone. write "fix", "Add", "change" instead of "fixed", "added", "changed ".
• Write a summary and describe what you have done in the command line mode. It is as if you are calling someone else.
• Write "fix", "add", "change", replace "fixed", "added", "changed ".

• Always leave the second line blank.
• Always leaves a blank 2nd rows.

• Line Break the commit message (to make the commit message readable without having to scroll horizontally inGitk).
• Use a line to segment the submitted message (to make the submitted message readable, you do not have to scroll horizontally in gitk ).

Don't

• Don't end the summary line with a period.
• I don't understand...

Tips

• If it seems difficult to summarize what your commit does, it may be because it has des several logical changes or bug fixes, and are better split up into several commits usingGit add-P.
• If it seems difficult to summarize what your commit is doing, it may be because it contains several logical changes or bug fixes. It is best to separate these commits and use git add-P.

References

The following blog post has a nice discussion of commit messages:

The following blog post is a good discussion of information submission.