Editing Commit message guidelines
Jump to navigation
Jump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 88: | Line 88: | ||
=== Wording === | === Wording === | ||
Please write "New function" instead of "Added function" or "Return retval" | |||
instead of "Changed to return retval". | |||
Never write "Fixed bug" or similar. That doesn't add any specific | |||
information about what was changed. | |||
The commit message should describe what was changed, not why it was changed. | |||
Any explanation for why a change is needed should appear as comments in the | |||
code, particularly if there is something that might not be obvious to someone | |||
reading it later. | |||
=== Body of the commit message === | === Body of the commit message === |