Skip to content

Contribute

ermshiperete edited this page Sep 10, 2012 · 10 revisions

If you want to actively contribute to the FieldWorks projects you need to register with some services.

Register with services

Gerrit

You should register with our Code Review server. Gerrit uses OpenId for authentication; you can use your existing Google account for that, or use or create an account with another OpenId provider.

If your OpenId provider supports it you should log in through https, otherwise you might get a warning.

Your Gerrit username should be firstname_lastname in all lowercase characters.

GitHub

In order to be able to modify the documentation on the wiki on GitHub you need a GitHub account.

Jenkins

You should also create an account on Jenkins. Instructions will be sent on request by sending an email to gerrit at sil.org.

Request Permissions

After creating accounts on Gerrit, GitHub, and Jenkins please send an email to gerrit at sil.org telling your usernames on these three services so that you can be given the correct permissions.

Adjust settings

Upload ssh key

Uploading changes to Gerrit is done through ssh. Gerrit needs to know your public key for identification. This means that you have to create and upload an ssh key. You might want to install git first by following the steps outlined in Getting Started With FieldWorks Development document.

When you have git installed it might be easiest to follow the instructions on GitHub. Be sure to click the appropriate tab for your OS before following the instructions.

Afterwards open git gui (on the Windows Start Menu, choose Programs > Git > Git GUI, or run git gui in a terminal in Linux). Choose Help > Show SSH Key and click the Copy To Clipboard button. Then log in to Gerrit and go to Settings, SSH Public Keys tab. Click the Add Key button and paste your SSH key from the clipboard.

To verify your SSH key is working correctly, open a terminal window (on Windows: git bash window) and connect to Gerrit's SSHD port (replacing firstname_lastname with your gerrit username):

$ ssh -p 59418 [email protected]

    ****    Welcome to Gerrit Code Review    ****

    Hi Firstname Lastname, you have successfully connected over SSH.
    
    Unfortunately, interactive shells are disabled.
    To clone a hosted Git repository, use:

    git clone ssh://[email protected]:59418/REPOSITORY_NAME.git

Connection to gerrit.lsdev.sil.org closed.

This might ask if you want to continue because it doesn't recognize Gerrit's public key (fingerprint of Gerrit's public key is 8c:66:e0:e9:f4:f2:ea:90:25:0e:05:76:2b:c1:03:6f). Answer yes to add the key to the list of authorized keys.

Clone this wiki locally