Differences
This shows you the differences between two versions of the page.
| 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 a **MUST**, but will help to track changes and follow the development easier. | + | Not an absolute |
| + | |||
| + | ===== 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 " | ||
| + | Please start always with the prefix of the subsystem that is modified by the commit | ||
| + | (e.g.: "core: typo fixes", | ||
| + | |||
| + | Examples: | ||
| + | < | ||
| + | usrloc: fixed name conflict | ||
| + | |||
| + | - destroy_avps() renamed to reg_destroy_avps() to avoid conflicts | ||
| + | with the usr_avp.h version. | ||
| + | </ | ||
| + | < | ||
| + | core: loadpath can now use a list of directories | ||
| + | |||
| + | - loadpath can use a list of directories separated by ':', | ||
| + | e.g.: loadpath " | ||
| + | First match wins (e.g. for loadmodule " | ||
| + | modules/ | ||
| + | be loaded and the search will stop). | ||
| + | </ | ||
| + | |||
| + | See: | ||
| + | |||
| + | * http:// | ||
| + | * http:// | ||
| ===== 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 " |
| ===== Module Commits ===== | ===== Module Commits ===== | ||
