Changes
Page history
Copied stuff from jpscore. just to test
authored
Jan 18, 2016
by
Erik Andresen
Hide whitespace changes
Inline
Side-by-side
docs/contributing/workflow.md
0 → 100644
View page @
0ce2d976
# Workflow
This is a git-specific workflow that helps you contribute flawlessly you JuPedSim.
-
Clone the project (for the first time)
```
python
git
clone
https
:
//
cst
.
version
.
fz
-
juelich
.
de
/
jupedsim
/
jpscore
.
git
```
-
Change to the developement branch and create a branch with your feature.
```
python
git
checkout
developement
git
checkout
-
b
feature_name
```
-
Write code and Commit changes
```
python
git
commit
-
m
"
Describe here your changes
"
```
-
Push your branch to GitLab. But before doing so,
[
test
](
pushing
)
your code.
```
python
git
push
origin
feature_name
```
-
Create a merge request
a *Master* will review your code & merge it to the developement branch (maybe).
## Tips Working with Git
1.
Pull frequently.
2.
Commit often, but don’t push every commit.
3.
Create one commit per unit of work. Break your changes down into multiple commits, e.g. "fix bug", "add documentation", etc.
4.
Push when changes are tested.
See also
[
8 Tips to help you work better with Git
](
https://about.gitlab.com/2015/02/19/8-tips-to-help-you-work-better-with-git/
)
.
__
_
**Top Tip**
: Your code is maybe fine if you see on the repository's front page this symbol

before your commit.