2017-12-28 10:20:56 -05:00
|
|
|
= Coding Standards =
|
2014-04-21 16:02:47 -04:00
|
|
|
|
2017-12-28 10:20:56 -05:00
|
|
|
Please follow our coding standards when developing:
|
2019-08-30 13:47:43 -04:00
|
|
|
https://git.jami.net/savoirfairelinux/ring-project/wikis/guidelines/Libring-coding-rules
|
2014-04-21 16:02:47 -04:00
|
|
|
|
2017-12-28 10:20:56 -05:00
|
|
|
= Gerrit Workflow =
|
2014-04-21 16:02:47 -04:00
|
|
|
|
2017-12-28 10:20:56 -05:00
|
|
|
Gerrit is used as a code review tool. It is also the primary Git repository.
|
2019-08-30 13:47:43 -04:00
|
|
|
Wiki documentation: https://git.jami.net/savoirfairelinux/ring-project/wikis/tutorials/Working-with-gerrit
|
2014-04-21 16:02:47 -04:00
|
|
|
|
2017-12-28 10:20:56 -05:00
|
|
|
== Commit Messages ==
|
2014-05-02 15:30:30 -04:00
|
|
|
|
2017-12-28 10:20:56 -05:00
|
|
|
Indicate the number of the related Tuleap issue in your commit message.
|
2014-05-02 15:30:30 -04:00
|
|
|
|
2014-04-21 16:02:47 -04:00
|
|
|
== commit-msg hook ==
|
|
|
|
|
2017-12-28 10:20:56 -05:00
|
|
|
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:
|
2015-03-25 15:27:18 -04:00
|
|
|
$ gitdir=$(git rev-parse --git-dir); scp -p -P 29420 username@gerrit-ring.savoirfairelinux.com:hooks/commit-msg ${gitdir}/hooks/
|
2014-04-21 16:02:47 -04:00
|
|
|
|
2017-12-28 10:20:56 -05:00
|
|
|
== Gerrit integration with Jenkins ==
|
2014-04-21 16:02:47 -04:00
|
|
|
|
|
|
|
* http://strongspace.com/rtyler/public/gerrit-jenkins-notes.pdf
|
|
|
|
* https://wiki.jenkins-ci.org/display/JENKINS/Gerrit+Trigger
|