1We are very much looking forward to your contribution to the RTRlib.
2Before you start, please consider the advice below.
3
4
5Code Contributions
6------------------
7
8If you intend to submit a major code contribution (e.g., new feature,
9extended modification of existing code), we highly encourage you to
10discuss this contribution with the RTRlib community using the Github
11Issue Tracker before you submit your pull request.
12
13In any case, proceed along the steps:
14
151. Fork the RTRlib Git repository (if you haven't done this already)
16
172. Create a branch
18
193. Make commits (details see below)
20
214. Make sure your code complies with Kernel Coding Style
22
23   * You can check this by running scripts/check-coding-style.sh <your file>
24
255. Submit a pull request
26
27  * If necessary, squash unnecessary commits before submitting the PR.
28
29  * We use a Continuous Integration system, which is linked in Github.
30    The results of the automatic tests are shown at the bottom of your
31    pull request.
32
336. Other RTRlib members will provide feedback
34
357. Address the feedback
36
37  * If necessary, squash unnecessary commits.
38
39
40Commit Messages
41---------------
42
43Commit messages should follow the structure
44
45  First line: modulename: brief description (max 50 chars)
46  Second line: <The second line is empty>
47  Further lines: More detailed description
48
49The description should be written in imperative and not in the past
50tense (e.g., "Remove unnecessary includes from header file" instead of
51"Unnecessary includes from header file removed"). Please be precise in
52the detailed description. For an example of a nice commit message see
53https://github.com/rtrlib/rtrlib/commit/f79471e43aa3eee8772360300661f8ead21f15f2.
54
55General information about good commits is available here
56
57  * http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
58
59  * http://git-scm.com/book/ch5-2.html
60
61
62/* vim: set tw=72 sts=2 sw=2 ts=2 expandtab: */
63