Changes
Page history
Remove chapter numbering to have proper sub-headings again, add youtube tutorials
authored
Oct 25, 2018
by
Karsten Suehring
Show whitespace changes
Inline
Side-by-side
VVC-Software-Development-Workflow.md
View page @
198e0973
...
@@ -3,11 +3,17 @@ VVC Software Development Workflow
...
@@ -3,11 +3,17 @@ VVC Software Development Workflow
It is generally advised to familiarize yourself with the usage of
**git**
and GitLab. Some sources are:
It is generally advised to familiarize yourself with the usage of
**git**
and GitLab. Some sources are:
Reading:
*
https://git-scm.com/book/en/v2
*
https://git-scm.com/book/en/v2
*
https://docs.gitlab.com/ee/user/index.html
*
https://docs.gitlab.com/ee/user/index.html
1.
Register
Youtube:
-----------
1) Git Introduction: https://www.youtube.com/watch?v=uR6G2v_WsRA
2) Git Branch Merge: https://www.youtube.com/watch?v=FyAAIHHClqI
3) Git Remotes: https://www.youtube.com/watch?v=Gg4bLk8cGNo
Register
--------
Got to the main page at https://vcgit.hhi.fraunhofer.de and select "Register" to register for an account. Fill in all required data.
Got to the main page at https://vcgit.hhi.fraunhofer.de and select "Register" to register for an account. Fill in all required data.
...
@@ -19,13 +25,13 @@ You will receive an email with a confirmation link.
...
@@ -19,13 +25,13 @@ You will receive an email with a confirmation link.
**Note:**
Email delivery can take up to 30 minutes.
**Note:**
Email delivery can take up to 30 minutes.
2.
Ask for internal account
Ask for internal account
------------------------
---
------------------------
Write an email with your user name to the software coordinators to request conversion to an internal account
Write an email with your user name to the software coordinators to request conversion to an internal account
3.
Create a fork of the VTM repository
Create a fork of the VTM repository
-----------------------------------
---
-----------------------------------
Go to
Go to
...
@@ -39,8 +45,8 @@ Select your own User workspace as target, e.g.
...
@@ -39,8 +45,8 @@ Select your own User workspace as target, e.g.


4.
Clone the repository locally and push your changes
Clone the repository locally and push your changes
--------------------------------------------------
---
--------------------------------------------------
If you did not use git before, set up your work environment using the
**git config**
tool using your name and email address.
If you did not use git before, set up your work environment using the
**git config**
tool using your name and email address.
...
@@ -111,8 +117,8 @@ Push to the remote repository using the name of the previously created branch, e
...
@@ -111,8 +117,8 @@ Push to the remote repository using the name of the previously created branch, e
git push
--set-upstream
origin K0261-SW-Cleanup
git push
--set-upstream
origin K0261-SW-Cleanup
```
```
5.
Create a merge request
Create a merge request
----------------------
---
----------------------
Got to the web page of your fork and create a merge request from the menu on the left side:
Got to the web page of your fork and create a merge request from the menu on the left side:
...
@@ -126,8 +132,8 @@ Fill in notes for the software coordinators and submit the merge request.
...
@@ -126,8 +132,8 @@ Fill in notes for the software coordinators and submit the merge request.
Keep all other settings as defaults.
Keep all other settings as defaults.
6.
Modifying a merge request
Modifying a merge request
-------------------------
---
-------------------------
There may be one or more issues with a merge request resulting in SW coordinators
There may be one or more issues with a merge request resulting in SW coordinators
denying the request and indicating in a comment what needs to be fixed.
denying the request and indicating in a comment what needs to be fixed.
...
@@ -140,8 +146,8 @@ A merge request may be updated as follows:
...
@@ -140,8 +146,8 @@ A merge request may be updated as follows:
**Note:**
There is no need to close the request, because the existing request will automatically be updated with the changes, after they are pushed.
**Note:**
There is no need to close the request, because the existing request will automatically be updated with the changes, after they are pushed.
7.
Keeping your fork in sync
Keeping your fork in sync
-------------------------
---
-------------------------
To pull changes from the upstream jvet repository into your own fork, first switch to the master branch
To pull changes from the upstream jvet repository into your own fork, first switch to the master branch
```
bash
```
bash
...
...
...
...