... | ... | @@ -11,15 +11,17 @@ Workflow for CE coordinators |
|
|
----------------------------
|
|
|
**Note:** CE development does not require an internal account.
|
|
|
|
|
|
Forking the main repository
|
|
|
First steps:
|
|
|
* (create an account)
|
|
|
* (contact SW coordinators to get CE maintainer status)
|
|
|
* Contact SW coordinators to get CE maintainer status
|
|
|
* Log in into your account
|
|
|
* Depending on whether the CE uses BMS or VTM as as basis go to
|
|
|
|
|
|
Forking the main repository:
|
|
|
* Depending on whether the CE uses BMS or VTM as it's basis go to
|
|
|
* the [jvet/VVCSoftware_VTM](https://vcgit.hhi.fraunhofer.de/jvet/VVCSoftware_VTM) repository page for VTM
|
|
|
* the [jvet/VVCSoftware_BMS](https://vcgit.hhi.fraunhofer.de/jvet/VVCSoftware_BMS) repository page for BMS
|
|
|
* Press the **fork** button
|
|
|
* Select the correct CE as destination
|
|
|
* Select the correct CE group as destination
|
|
|
* You will automatically be redirected to new fork
|
|
|
|
|
|
Creating branches:
|
... | ... | @@ -29,7 +31,7 @@ Creating branches: |
|
|
* Repeat branch creation as necessary
|
|
|
|
|
|
Adding users:
|
|
|
* Hover over "Settings" on the left side menu and select "Members"
|
|
|
* On the CE project page hover over "Settings" on the left side menu and select "Members"
|
|
|
* Select the user to be added (typing parts of the user name works as search)
|
|
|
* Select "Reporter" for read access or "Developer" for write access
|
|
|
* Repeat adding users as necessary
|
... | ... | @@ -38,11 +40,13 @@ Workflow for CE members (writing) |
|
|
---------------------------------
|
|
|
|
|
|
If you don't have a GitLab account, register at https://vcgit.hhi.fraunhofer.de
|
|
|
For more details on registration see [VVC software development workflow](VVC-Software-Development-Workflow)
|
|
|
For more details on registration see the [VVC software development workflow](VVC-Software-Development-Workflow)
|
|
|
|
|
|
**Note:** CE development does not require an internal account.
|
|
|
|
|
|
If you did not use git before, set up your work environment using the **git config** tool using your name and email address.
|
|
|
The following steps require git to be installed and accessible from the command line.
|
|
|
|
|
|
If you did not use git before, set up your work environment using the **git config** tool using your name and email address:
|
|
|
|
|
|
```bash
|
|
|
git config --global user.name "John Doe"
|
... | ... | @@ -63,15 +67,13 @@ To clone the CE repository, type |
|
|
git clone <url> [target_path]
|
|
|
```
|
|
|
|
|
|
with the ```<url>``` of the repository that can be found in the web page of your CE repository
|
|
|
|
|
|
The URL can be found on the project page of the CE:
|
|
|
with the ```<url>``` of the repository that can be found in the web page of your CE repository. It can be found on the project page of the CE:
|
|
|
|
|
|
![04-url](/uploads/6dd857de635b5123bec72e44fb96d4f1/04-url.png)
|
|
|
|
|
|
```target_path``` is an optional parameter. If you are working on multiple CEs, it may be helpful to clone them into different directories names after the CE, e.g. *VVCSoftware_BMS_CE1*
|
|
|
```target_path``` is an optional parameter. If you are working on multiple CEs, it may be helpful to clone different CEs into different directories named after the CE, e.g. *VVCSoftware_BMS_CE1*
|
|
|
|
|
|
**Note:** The CE repository should have something like "JVET-?-CE?" in it's URL. Make sure to clone the right CE.
|
|
|
**Note:** The CE repository should have something like "JVET-?-CE?" in it's URL. Make sure to clone the correct CE.
|
|
|
|
|
|
Change into the cloned copy of the repository and create a branch for checking in software, e.g.:
|
|
|
|
... | ... | @@ -115,7 +117,7 @@ changes with git diff. If the changes go beyond what you expected |
|
|
files with ```git checkout -- <file>```. If the changes look great, stage them with
|
|
|
git add.
|
|
|
|
|
|
Commit the changes to the local repository with:
|
|
|
Commit all changes to the local repository with:
|
|
|
|
|
|
```bash
|
|
|
git commit -a
|
... | ... | |