Differences

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

--- devel:github-contributions [2015/08/24 19:40]
miconda created
+++ devel:github-contributions [2016/03/02 12:08]
miconda [Commit Message Format]
@@ Line 28: / Line 28: @@
   * when the case, make references to the item on bug tracker, using GH#XYZ - replace XYZ with issue number id
     * e.g.,: - issue reported by John Smith, GH#123
+  * changes to **README** file of modules must not be done directly in that file. Instead, edit the xml files located in **modules/modname/doc/** folder
+    * to regenerate the README, run **make modules-readme modules=modules/modname**
+    * docbook utils and xsl packages are needed for the above command to work
+    * it is ok to modify only the xml doc file, the readme can be regenerated by another developer who has the required tools installed
+    * if it is a change to README that needs to be backported, make separate commits to xml doc file and README. The changes to README files are very likely to rise merge conflicts. With separate commit, that won't be backported, only the commit to xml doc file, then README will be manually regenerated in the corresponding branch.
@@ Line 46: / Line 51: @@
   * module_name: support for foo rfc extension
   * lib_name: critical bug fix for abc case
+  * kamctl: added support for management of module xyz
 Examples of commit messages:
@@ Line 76: / Line 82: @@
 The above content about commit message format is taken from wiki page [[devel:git-commit-guidelines|GIT Commit Guidelines]] - it is recommended you read that one as well.
+===== Further Assistance =====
+For any question, do not hesitate to contact other developers via mailing list:
+  * **<sr-dev [at] lists.sip-router.org>**

Kamailio SIP Server Wiki

User Tools

Site Tools

Differences

Page Tools