1 of 6

Titan contributor workflow�(Committing directly to eclipse/titan.* using Gerrithub)

Step-by-step guide for contributors

2 of 6

Prerequisites

  • Working git setup
  • Registration with GitHub
  • Registration with Eclipse (don’t forget to add your GitHub ID to the registration form) and signed ECA
  • Full Committer status on the tools.titan project
  • GerritHub login tested and working with GitHub ID
  • Add Your ssh public key both to GitHub and GerritHub accounts

3 of 6

Clone the GerritHub repo and make the change

  • Clone the repo from GerritHub
    • git clone ssh://<username>@review.gerrithub.io:29418/eclipse/titan.core
    • git clone ssh://<username>@review.gerrithub.io:29418/eclipse/titan.EclipsePlug-ins
    • ...�
  • Modify the files and compile

4 of 6

Testing the changes

  • For every change tests should be added;the test code should be committed together with the modified source code
  • If any existing tests, those should be executed before committing the code to make sure nothing is broken; for titan.core and the Eclipse plug-ins a comprehensive set of function and regression tests exists; for some protocol modules or test ports these tests might be absent, however some tests for the modifications should be added; if unsure how existing tests should be executed, please ask.
  • Later in the Pull Request please include a statement about the successful execution of the tests

5 of 6

Add the files and commit them

  • Pull the eventual changes from the central repo (and resolve merge conflicts if any)
    • git pull git@github.com:eclipse/titan.*
    • git push
  • Use “git add” to add changed files to the commit
    • git add <changed_file1>
    • git add <changed_file2>
    • git add <changed_file3>
    • …�Or:
    • git add -A
  • When committing the change to the local repo don’t forget to use the “-s” flag
    • git commit -s -m “CommitMessage”
  • Push the change using the following command:
    • git push origin HEAD:refs/for/master

6 of 6

Add reviewers

  • In GerritHub look for the latest change in the menu “Your” -> “Changes”
  • Add reviewers using the “ADD REVIEWER” link to the right of “Reviewers” as shown in the picture below:

​