... | ... | @@ -32,3 +32,90 @@ Adding users: |
|
|
* 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
|
|
|
|
|
|
Workflow for CE members (writing)
|
|
|
---------------------------------
|
|
|
|
|
|
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"
|
|
|
git config --global user.email johndoe@example.com
|
|
|
```
|
|
|
|
|
|
Also enable proper automatic handling of line endings:
|
|
|
|
|
|
```bash
|
|
|
git config --global core.autocrlf input
|
|
|
```
|
|
|
|
|
|
For more details see https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup
|
|
|
|
|
|
To clone the CE repository, type
|
|
|
|
|
|
```bash
|
|
|
git clone <url>
|
|
|
```
|
|
|
|
|
|
with the ```<url>``` of the repository that can be found in the web page of your CE repository
|
|
|
|
|
|
![04-url](/uploads/6dd857de635b5123bec72e44fb96d4f1/04-url.png)
|
|
|
|
|
|
**Note:** The CE repository should have something like "JVET-?-CE?" in it's URL.
|
|
|
|
|
|
Change into the cloned copy of the repository and create a branch for checking in software, e.g.:
|
|
|
|
|
|
```bash
|
|
|
cd VVCSoftware_BMS
|
|
|
```
|
|
|
|
|
|
To list available branches type
|
|
|
|
|
|
```bash
|
|
|
git branch --remote
|
|
|
```
|
|
|
|
|
|
To switch into the appropriate branch type
|
|
|
|
|
|
```bash
|
|
|
git checkout CE1.1
|
|
|
```
|
|
|
|
|
|
assuming the branch is named CE1.1
|
|
|
|
|
|
Make the required modifications. New files have to be added using the command:
|
|
|
|
|
|
```bash
|
|
|
git add <file(s)>
|
|
|
```
|
|
|
|
|
|
It is good practice to run ```git diff``` before adding the files, such as to check
|
|
|
what changes are actually being added. If listed changes are not the ones you made,
|
|
|
then you shouldn't proceed.
|
|
|
|
|
|
Optionally (for advanced users), automated formatting can then be applied
|
|
|
using the command:
|
|
|
```bash
|
|
|
git clang-format
|
|
|
```
|
|
|
Note that this requires clang-format to be installed on your system. A list of
|
|
|
modified files (if any) is printed. If files are modified, please check the
|
|
|
changes with git diff. If the changes go beyond what you expected
|
|
|
(for example parts that you didn't edit got reformatted), you should revert individual
|
|
|
files with ```git checkout -- <file>```. If the changes look great, stage them with
|
|
|
git add.
|
|
|
|
|
|
Commit the changes to the local repository with:
|
|
|
|
|
|
```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. `--amend` should only be used, if the previous change was not pushed to the remote repository yet.
|
|
|
|
|
|
Push to the remote repository:
|
|
|
|
|
|
```bash
|
|
|
git push
|
|
|
``` |