|
|
VVC Software Development Workflow
|
|
|
=================================
|
|
|
|
|
|
It is generally advised to familiarize yourself with the usage of **git** and GitLab. Some sources are:
|
|
|
|
|
|
* https://git-scm.com/book/en/v2
|
|
|
* https://docs.gitlab.com/ee/user/index.html
|
|
|
|
|
|
1. Register
|
|
|
------------
|
|
|
|
... | ... | @@ -37,17 +42,59 @@ Select your own User workspace as target, e.g. |
|
|
|
|
|
If you did not use git before, set up your work environment using the **git config** tool using your name and email address.
|
|
|
|
|
|
`git config --global user.name "John Doe"
|
|
|
git config --global user.email johndoe@example.com`
|
|
|
|
|
|
```bash
|
|
|
git config --global user.name "John Doe"
|
|
|
git config --global user.email johndoe@example.com
|
|
|
```
|
|
|
For more details see https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup
|
|
|
|
|
|
To clone the (forked) git repository, type
|
|
|
|
|
|
`git clone url`
|
|
|
```bash
|
|
|
git clone <url>
|
|
|
```
|
|
|
|
|
|
with the *url* of the repository that can be found in the web page of your forked repository
|
|
|
with the ```<url>``` of the repository that can be found in the web page of your forked repository
|
|
|
|
|
|
![04-url](/uploads/6dd857de635b5123bec72e44fb96d4f1/04-url.png)
|
|
|
|
|
|
Change into the cloned copy of the repository and create a branch for checking in software, e.g.:
|
|
|
|
|
|
```bash
|
|
|
cd VVCSoftware_BMS
|
|
|
git checkout -b K0261-SW-Cleanup
|
|
|
```
|
|
|
|
|
|
Make the required modifications. New files have to be added using the command:
|
|
|
|
|
|
```bash
|
|
|
git add <file(s)>
|
|
|
```
|
|
|
|
|
|
to commit the changes to the local repository
|
|
|
|
|
|
```bash
|
|
|
git commit -a
|
|
|
```
|
|
|
Make sure to write a proper comment.
|
|
|
|
|
|
If you need to add changes, these can be committed using the `--amend` flag to add them to the previous commit.
|
|
|
|
|
|
Push to the remote repository using the name of the previously created branch, e.g.:
|
|
|
|
|
|
```bash
|
|
|
git push --set-upstream origin K0261-SW-Cleanup
|
|
|
```
|
|
|
|
|
|
5. Create a merge request
|
|
|
-------------------------
|
|
|
|
|
|
Got to the web page of your fork and create a merge request from the menu on the left side:
|
|
|
|
|
|
Select "Merge Requests", then "New merge request", the select your source branch and the master branch of the main repository as target:
|
|
|
|
|
|
![05-create_request](/uploads/e38eb219d0bbc6b500f1b3090abcdf18/05-create_request.png)
|
|
|
|
|
|
Select "Compare branches and continue"
|
|
|
|
|
|
Fill in notes for the software coordinators and submit the merge request. |