Skip to content

Commit 6bb9700

Browse files
authored
Update CONTRIBUTING.md
1 parent 3e42e0b commit 6bb9700

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,14 @@ We use the [Black Code Formatter](https://github.com/ambv/black) to clean up our
7070
before commiting.
7171

7272

73-
## Git commit messages
73+
## Git conventions
7474

7575
We'd really appreciate if you adhere to the [standard convention for Git commit messages](https://chris.beams.io/posts/git-commit/). It's like chopping veggies in the kitchen: You're gonna be doing this your entire life, might as well do it right. That being said, for small changes, we're completely fine with one-liners.
7676

7777
Also, have a look at this [blogpost](https://www.spreedly.com/2014/06/24/merge-pull-request-considered-harmful/) how we handle pull-requests. It might help you to understand our workflow...
7878

79+
The Phobos repository is based on the git structure you can find in the [wiki](https://github.com/dfki-ric/phobos/wiki/Installation#versions-and-branching). We decided to drop the GitFlow method as it was too cumbersome for us, and instead introduced our own Git method which relies on rebasing of code. Every maintainer should use his/her own fork to keep the feature branches, which allows for easier rebasing before a merge into the master branch.
80+
7981
---
8082

8183
Thanks for considering this lengthy advice,

0 commit comments

Comments
 (0)