Skip to content
Snippets Groups Projects
Unverified Commit 24642393 authored by Elemer Lelik's avatar Elemer Lelik Committed by GitHub
Browse files

Update CONTRIBUTING.md

parent ad8a6b6e
No related branches found
No related tags found
No related merge requests found
# Titan contributor workflow
(Committing directly to eclipse/titan.* using Gerrithub)
Step-by-step guide for contributors
# Contributor workflows:
## 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
## Simplified Titan contributor workflow ( to be applied when agreed previously)
Committing directly to github.com/eclipse/titan.* using Gerrithub:
## 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
* https://docs.google.com/presentation/d/1j5RxJC13gFCCGcLB7ZwyDVCzBWroapUR9AVdqB5fdig/edit#slide=id.p
* Modify the files and compile
## Titan contributor workflow to github.com/eclipse/titan.*
covering Gerrit code review
## Test the changes
* https://docs.google.com/presentation/d/1AVi3Be3qYmkYm6VEf4BnYHYa3hwpjjIM5EQc7W6LtNE/edit#slide=id.p
* 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
## 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
## Add reviewers
* In GerritHub look for the latest change in “My” -> “Changes”
* Add reviewers using the tiny figure button with the plus sign to the right of “Reviewers”
# Simplified Titan contributor workflow
(to be applied when agreed previously)
Step-by-step guide for contributors
## Prerequisites
* Working git setup
* Registration with GitHub (don’t forget to add your ssh public key!)
* Registration with Eclipse (don’t forget to add your GitHub ID to the registration form) and signed ECA
## Create your own Fork on GitHub
* Log in to GitHub
* Search for the repository you are interested in, say “titan.misc”
* Click on “eclipse/titan.misc” (should be the first in the result list)
* Click on “Fork” button on the top right
* You should be redirected to <username>/titan.misc repository
## Clone Your GitHub repo, make the changes and compile
* Clone the repo
* git clone git@github.com:/<username>/titan.misc.git
Or
* git clone https://github.com/<username>/titan.misc.git
* Add your changes and compile
## Test 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
## Add your changes and commit
* 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 changes to the local repo don’t forget to use the “-s” (sign-off) flag
* git commit -s -m “CommitMessage”
* Push the changes using the following command:
* git push
## Titan contributor workflow to Eclipse git
Committing to git.eclipse.org/titan.* through gerrit code review
* https://docs.google.com/presentation/d/15zA7HjTlvEOshSb5W9qFQ7e4zIAU6Blk3_EV8ewYy_Y/edit#slide=id.p
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment