Commit 84fbe3ba authored by Rami Alshafi's avatar Rami Alshafi

getting started doc

parents
Creating an account
Please send your name and e-mail to staff@openconnectivity.org with the subject line as "OCF Gitlab Account Creation"
Setting up SSH access (optional)
In order to enable SSH access to git lab, an SSH key pair needs to be used. Learn how to create one here or learn how to use an already existing ssh key here.
Once you obtain an SSH key pair, learn how to add it to your Gitlab account here.
Once the ssh key has been added, it is advised to test the setup. Learn how to test the added ssh key here.
Workflow
Cloning a repository
To find a project, log in to your Gitlab account and select the "Projects" tab in the upper left corner then select "Explore projects" from the dropdown menu
The trending project will be listed by default. To list all projects, select the "All" sub tab as shown in the screen shot below.
Select the project and the project details page will open up. In the upper right corner, there is the "clone" blue button. Clicking it will give you the available options for cloning the projects; vis ssh or https. If you have not already setup your ssh key then use the https link instead.
Copy the clone path and type the following command
$ git clone <paste the clone path here>
Merge Request
Merge requests allow us to exchange changes made to source code and collaborate with developers in Gitlab. Additionally, merge requests serve as a code review as well. There is no need to fork the entire project although you can.
In order to submit a merge request to any project in Gitlab, do the following steps:
create your own branch
From the root directory of your local cloned repository, type the following command
$ git checkout -b <name of your branch>
make your changes in commits
Once you make the changes, stage and commit your changes and push your local branch to the remote repository with the following command
$ git push -u origin <name of your branch>
Create the merge request.
Log into your Gitlab account and go to the project and checkout your branch and issue the merge request.
Merge conflicts
Merge conflicts will be highlighted in a merge request along with the result of the CI testing. More commits and code changes can be made within the merge request. Once the merge conflict is complete, assign it to someone with merge privileges to merge your changes.
House keeping
It is customary to squash all commits in your feature branch into one or a few logically organized commits and delete your feature branch once merged into the target branch.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment