CODING 1.08 KB
Newer Older
1
= Coding Standards =
2

3
Please follow our coding standards when developing:
4
https://git.ring.cx/savoirfairelinux/ring-project/wikis/guidelines/Libring-coding-rules
5

6
= Gerrit Workflow =
7

8
Gerrit is used as a code review tool. It is also the primary Git repository.
9
Wiki documentation: https://git.ring.cx/savoirfairelinux/ring-project/wikis/tutorials/Working-with-gerrit
10

11
== Commit Messages ==
12

13
Indicate the number of the related Tuleap issue in your commit message.
14

15 16
== commit-msg hook ==

17 18 19 20 21
The Gerrit commit-msg hook must be installed before code reviews can be pushed to Gerrit.
This is because Gerrit relies on a unique Change-Id that can be tracked. The commit-msg hook
takes care of inserting a Change-Id in your commit messages for you.

It can be installed in your local git repository with the following command:
22
$ gitdir=$(git rev-parse --git-dir); scp -p -P 29420 username@gerrit-ring.savoirfairelinux.com:hooks/commit-msg ${gitdir}/hooks/
23

24
== Gerrit integration with Jenkins ==
25 26 27

* http://strongspace.com/rtyler/public/gerrit-jenkins-notes.pdf
* https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger