Editing Commit message guidelines

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 88: Line 88:
 
=== Wording ===
 
=== Wording ===
  
{| class="wikitable"
+
Please write "New function" instead of "Added function" or "Return retval"
! bad
+
instead of "Changed to return retval".
! good
+
 
|-
+
Never write "Fixed bug" or similar. That doesn't add any specific
| style="color:darkred;" | "Added function"
+
information about what was changed.
| style="color:green;" | "New function"
+
 
|-
+
The commit message should describe what was changed, not why it was changed.
| style="color:darkred;" | "Changed to return retval"
+
Any explanation for why a change is needed should appear as comments in the
| style="color:green;" | "Return retval"
+
code, particularly if there is something that might not be obvious to someone
|-
+
reading it later.
| 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.
 
  
 
=== Body of the commit message ===
 
=== Body of the commit message ===

Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Template used on this page: