Changes between Version 9 and Version 10 of GitNotes


Ignore:
Timestamp:
04/10/13 18:22:39 (7 years ago)
Author:
tim
Comment:

More clearly specify subject in commit message

Legend:

Unmodified
Added
Removed
Modified
  • GitNotes

    v9 v10  
    8080Longer text describing the change. 
    8181}}} 
    82 The subject is a brief explanation of the change and may not exceed 60 characters in length. Then follows an empty line and then a longer text describing the change in more detail. If you think you cannot fit the change in your subject chance is that you should break up the commits in more smaller commits. The longer text can be omitted if the subject line is already sufficiently clear. In the longer message think that you need to explain the change to someone else. 
     82The subject is a brief explanation of the change and may not exceed 60 characters in length. It should start with a component name, e.g. the name of a plugin the code belongs to. The subject line has a specific relevance. Many git tools (e.g. gitk) show only the first line in the default view and therefore this line should be short and concise. Then follows an empty line and then a longer text describing the change in more detail. If you think you cannot fit the change in your subject chance is that you should break up the commits in more smaller commits. The longer text can be omitted if the subject line is already sufficiently clear. In the longer message think that you need to explain the change to someone else. An example: 
     83{{{ 
     84tabletop-objects: ignore unknown pragmas 
     85 
     86Disable unknown pragmas warning to fix a problem with PCL 1.6 
     87}}} 
    8388 
    8489=== ^advanced^ (Re-)Organizing your Commits ===