Differences

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

Link to this comparison view

Next revision
Previous revision
devel:git-commit-guidelines [2009/04/16 12:24]
82.113.121.154 created
devel:git-commit-guidelines [2009/04/16 14:09] (current)
andrei
Line 1: Line 1:
 ====== GIT Commit Guidelines ====== ====== GIT Commit Guidelines ======
  
-Not **MUST**, but will help to track changes and follow the development easier.+Not an absolute **MUST**, but it **SHOULD** be used almost always. It helps to track changes and follow the development easier (better commit mail messages and Changelogs are easier to generate). 
 + 
 +===== Commit message ===== 
 + 
 +Please create the commit messages following the git convention: 
 + 
 +  * start with one short line, preferably less then 50 chars summarising the changes (this is referred later as "first line of the commit message"
 +  * then one empty line 
 +  * then a more detailed description 
 + 
 +Think of the first line as of an email "Subject" line. In fact it will be used as "Subject" in the generated commit mails and it will also be used when generating the Changelog (e.g. git log --pretty=oneline). 
 +Please start always with the prefix of the subsystem that is modified by the commit 
 +(e.g.: "core: typo fixes", "tcp: stun fixes", "mem: faster malloc", "module_name: support for foo", "lib_name: critical bug fix"). 
 + 
 +Examples: 
 +<code> 
 +usrloc: fixed name conflict 
 + 
 + - destroy_avps() renamed to reg_destroy_avps() to avoid conflicts 
 +   with the usr_avp.h version. 
 +</code> 
 +<code> 
 +core: loadpath can now use a list of directories 
 + 
 +- loadpath can use a list of directories separated by ':', 
 +  e.g.: loadpath "modules:modules_s:modules_k"
 +  First match wins (e.g. for loadmodule "textops" if 
 +  modules/textops.so or modules/textops/textops.so exists, it will 
 +  be loaded and the search will stop). 
 +</code> 
 + 
 +See: 
 + 
 +  * http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#creating-good-commit-messages 
 +  * http://www.tpope.net/node/106
  
 ===== Generic Guidelines ===== ===== Generic Guidelines =====
Line 9: Line 43:
 ===== Core Commits ===== ===== Core Commits =====
  
-  * prefix the first line of the commit message with "core: "+  * prefix the first line of the commit message with "core:", or with the subsystem prefix (e.g. "tcp", "dns", "mem", "script" a.s.o).
  
 ===== Module Commits ===== ===== Module Commits =====

Navigation

Wiki

Other

QR Code
QR Code devel:git-commit-guidelines (generated for current page)