Merge pull request #1435 from kamailio/cchance/presence
[sip-router] / .github / CONTRIBUTING.md
1 # Contributing To Kamailio #
2
3 *First, thank you for taking the time to contribute to Kamailio project!*
4
5 The following is a set of guidelines for contributing to Kamailio sources and
6 documentation. Kamailio source tree is hosted in the [Kamailio Organization](https://github.com/kamailio) on GitHub.
7
8 These are intended to be more like guidelines to keep everything consistent and
9 coherent, not very strict rules. Use your best judgment and feel free to propose
10 changes to this document in a pull request.
11
12 ### Table Of Contents ###
13
14   * [Overview](#overview)
15   * [Contributing Code Or Content](#contributing-code-or-content)
16     * [Basic Rules](#basic-rules)
17     * [Commit Message Format](#commit-message-format)
18       * [Examples Of Commit Messages](#examples-of-commit-messages)
19       * [See Also](#see-also)
20   * [Reporting Issues](#reporting-issues)
21   * [License](#license)
22     * [License Of New Code Contributions](#license-of-new-code-contributions)
23   * [Further Assistance](#further-assistance)
24
25 ## Overview ##
26
27 Kamailio is a community managed project, with developers world wide. Any
28 contribution to code or documentation is very welcome and appreciated.
29
30 In order to be easily able to track the changes and have a coherent ChangLog
31 and commit history, there are several *rules* required for each contribution.
32
33 ## Contributing Code Or Content ##
34
35 ### Basic Rules ###
36
37   * github pull requests are the favourited mechanism to submit contributions
38   (patches)
39   * make a pull request against **master branch**
40     * commit can be later backported to stable branch(es)
41   * make a pull request for each new feature
42     * e.g., if you add a feature to usrloc module and an unrelated feature
43     to auth module, then make two pull requests
44   * it is ok (and sometime recommended) to have more than one commit per pull request
45   * make a commit for each affected component. A component is considered to be:
46     * the core
47     * an internal library (code inside subfolder lib/)
48     * a module (code inside subfolder modules/)
49     * a tool (code inside subfolder utils/)
50     * an example or main configs (files inside subfolders etc/ or examples/)
51   * commit messages **has to be formatted** as specified in the next section
52   * commit message must describe the changes done by the patch
53     * other details (e.g., how to reproduce, backtrace, sip packets, ...) belong
54     to content (comments) of the pull request
55   * avoid emoticons and non-technical statements in commit messages
56     * e.g., if it was a feature request by John Smith, don't mention that in
57     commit message, especially don't write it owns you now a beer
58   * credits can be given within commit message as a short statement, mentioning
59   the name of the person or entity
60     * for commits introducing a new module, credits must not be included in the
61     commit message, being expected that the respective entity will own the
62     copyright and it is reflected in the README or copyright header of each file
63   * when the case, make references to the item on bug tracker, using GH #XYZ
64   -- replace XYZ with issue number id
65     * e.g.,: - issue reported by John Smith, GH #123
66   * changes to **README** file of modules **must** not be done directly in that
67   file. Instead, edit the xml files located in **modules/modname/doc/** folder
68     * to regenerate the README, run **make modules-readme modules=modules/modname**
69     * docbook utils and xsl packages are needed for the above command to work
70     * it is ok to modify only the xml doc file, the readme can be regenerated by
71     another developer who has the required tools installed
72     * if it is a change to README that needs to be backported, make separate
73     commits to xml doc file and README. The changes to README files are very
74     likely to rise merge conflicts. With separate commit, that won't be
75     backported, only the commit to xml doc file, then README will be manually
76     regenerated in the corresponding branch.
77   * code **should** be formatted with **clang-format** or to match the style of
78   the component that the commit applies to. The `.clang-format` file is part of
79   Kamailio source code tree, in the root folder.
80
81
82 ### Commit Message Format ###
83
84 Please create the commit messages following the GIT convention:
85
86   * start with one short line, preferably less then 50 chars summarizing the
87   changes (this is referred later as "first line of the commit message")
88   * then one empty line
89   * then a more detailed description
90
91 Think of the first line as of an email "Subject" line. In fact it will be used
92 as "Subject" in the generated commit emails and it will also be used when
93 generating the Changelog (e.g. git log --pretty=oneline).
94
95 Please start always with the prefix of the component (subsystem) that is modified by the commit, for example:
96   * `core`: typo fixes to log messages
97   * `tcp`: stun fixes
98   * `mem`: added faster malloc
99   * `module_name`: support for foo rfc extension
100   * `lib_name`: critical bug fix for abc case
101   * `kamctl`: added support for management of module xyz
102
103 #### Examples Of Commit Messages ####
104
105   * change to usrloc module from modules
106
107 ```
108 usrloc: fixed name conflict
109
110 - destroy_avps() renamed to reg_destroy_avps() to avoid conflicts
111   with the usr_avp.h version
112 ```
113
114   * change to core
115
116 ```
117 core: loadpath can now use a list of directories
118
119 - loadpath can use a list of directories separated by ':',
120   e.g.: loadpath "modules:modules_s:modules_k".
121   First match wins (e.g. for loadmodule "textops" if
122   modules/textops.so or modules/textops/textops.so exists, it will
123   be loaded and the search will stop).
124 ```
125
126 #### See Also ####
127
128   * [Creating Good Commit Messages](http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#creating-good-commit-messages)
129   * http://www.tpope.net/node/106
130
131 The above content about commit message format is taken from Kamailio wiki page:
132   * https://www.kamailio.org/wiki/devel/git-commit-guidelines
133   * it is recommended you read that one as well.
134
135 ## Reporting Issues ##
136
137 Whenever reporting an issue, along with the description of the problems, try to
138 include following details:
139
140   * kamailio version you are using
141     * the output of: **kamailio -v**
142   * the operating system being used
143   * the CPU architecture
144
145 Always useful to have:
146
147   * whenever there is a crash with a corefile, send the backtrace
148     * the output of **bt full** in **gbd**
149   * log messages printed by kamailio in syslog file
150   * *pcap* or *ngrep* capture of SIP packets causing the issue
151   * config file snippets which expose the issues
152
153 Note: replace any sensitive information in the content you add to the issue
154 (e.g., passwords in modparams can be replaced with xyz, each IP address can be
155 replaced with tokens like a.b.c.d, f.g.h.j).
156
157 ## License ##
158
159 Kamailio Main License: *GPLv2*.
160
161 Each source code file refers to the license and copyright details in the top
162 of the file. Most of the code is licensed under GPLv2, some parts of the code
163 are licensed under BSD.
164
165 ### License Of New Code Contributions ###
166
167 New contributions to the core and several main modules (auth, corex, sl, tls,
168 tm) have to be done under the BSD license. New contributions under the GPL must
169 grant the GPL-OpenSSL linking exception. Contributions to existing components
170 released under BSD must be done under BSD as well.
171
172 ## Further Assistance ###
173
174 For any question, do not hesitate to contact other developers via mailing list:
175
176   * **[sr-dev [at] lists.kamailio.org](http://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev)**