User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
en:devel:commitguidelines [2017/06/16 11:18]
127.0.0.1 external edit
en:devel:commitguidelines [2019/04/23 00:00] (current)
joebordes
Line 4: Line 4:
  
 <​code><​type>​(<​scope>​) <​subject></​code>​ <​code><​type>​(<​scope>​) <​subject></​code>​
-  ​* Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on github ​as well as in various git tools.+ 
 +another way of reading that is: 
 + 
 +<​code>​what(where) how</​code>​ 
 + 
 +in this second form, the //when// and //who// are controlled by git itself, so sign your commits. 
 + 
 +Some additional clarifications:​ 
 + 
 +  ​* Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub ​as well as in various git tools.
   * Allowed **<​type>​**   * Allowed **<​type>​**
     * **feat**: feature     * **feat**: feature
Line 17: Line 26:
     * **chore**: maintenance tasks     * **chore**: maintenance tasks
   * Allowed **<​scope>​** could be anything specifying place of the commit change. For example a module name, webservice or functional feature   * Allowed **<​scope>​** could be anything specifying place of the commit change. For example a module name, webservice or functional feature
-  * **<​subject>​** line contains succinct description of the change. Use imperative, present tense: “change” not “changed” nor “changes”. If the commit fixes or is related to a ticket ​we will put the [[https://​www.mantisbt.org/​|MantisBT]] regular expression here+  * **<​subject>​** line contains succinct description of the change. Use imperative, present tense: “change” not “changed” nor “changes”. 
 +    * If the commit fixes or is related to a ticket put the title or a summary of it, the actual ticket number is rather useless as time has taught me that ticket systems come and go while code and commit messages persist.