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 85: | Line 85: | ||
** <code>test:</code> for changes to [[Tests]] only, e.g. new/removed BISTs, changed tolerances, etc. | ** <code>test:</code> for changes to [[Tests]] only, e.g. new/removed BISTs, changed tolerances, etc. | ||
=== Body of the commit message === | === Body of the commit message === | ||
Line 133: | Line 115: | ||
For m-file and Fortran sources, the function name can be omitted if the file contains only one function. For changes outside of functions or classes, of course the parenthetical (function) or (class::function) specifiers can also be omitted. | For m-file and Fortran sources, the function name can be omitted if the file contains only one function. For changes outside of functions or classes, of course the parenthetical (function) or (class::function) specifiers can also be omitted. | ||
=== Wording === | |||
{| class="wikitable" | |||
! bad | |||
! good | |||
|- | |||
| style="color:darkred;" | "Added function" | |||
| style="color:green;" | "New function" | |||
|- | |||
| style="color:darkred;" | "Changed to return retval" | |||
| style="color:green;" | "Return retval" | |||
|- | |||
| style="color:darkred;" | "Fixed bug" | |||
| style="color:green;" | Write '''what''' has changed. | |||
|} | |||
The commit message should describe '''what''' was changed, not '''why''' it was changed. Any explanations should appear as comments in the code, particularly if there is something that might not be obvious to someone reading it later. | |||
[[Category:Development]] | [[Category:Development]] |