[FEATURE] Add walktrough to create merge requests

[jirafeau_mojo42.git] / CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 641fb44c18403ace6de893be36eee2206847ecec..f7f21ed79399c5b92d03ca563031c924057059dc 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,6 +4,8 @@ Hi,
 
 this document is made for newcomers in Jirafeau who are digging into the code.
 
+If you have further questions, then just ask for help 🤓.
+
 ## General principle
 
 Jirafeau is made in the [KISS](http://en.wikipedia.org/wiki/KISS_principle) way (Keep It Simple, Stupid).
@@ -55,12 +57,9 @@ Translation may be add via [Jirafeau's Weblate](https://hosted.weblate.org/proje
 
 ## Coding style
 
-- PHP function keywords are alone on a line
-- Braces "{" must be put in a new line
+- This project follows the [PSR-2](http://www.php-fig.org/psr/psr-2/) Coding Style
 - Files must be in UTF-8 without BOM and use Unix Line Endings (LF)
 
-The whole project is not clean about that yet, feel free to fix :)
-
 ## Branches
 
 * ```master``` = latest release, e.g. 2.0.1
@@ -74,3 +73,14 @@ Please create one branch for each feature and send one merge request for each br
 Dont squash several changes or commits into one merge request as this is hard to review.
 
 Please use ```next-release``` as base branch and send your merge request to this branch (not ```master```).
+
+Quick walktrough:
+
+* Create ticket for new feature
+* Fork the original repository, clone the own repository, add the original repository as upstream
+* Checkout »next-release« branch ```git checkout next-release```
+* Create a new branch on top of that one, e.g. »some-feature« ```git checkout -b some-feature```
+* Commit changes → push → send merge request ```git add -A; git commit; git push``` MR via GitLab (link shown in console)
+* Feature is reviewed
+  * MR accepted: Reviewer checks out »next-release« branch and cherry-picks the commit ```git checkout next-release; git cherry-pick be4369641; git push```
+  * MR declined: Reviewer add some notes, Developer rebases his branch, adds neccessary changes, force pushes the branch, ask a reviewer to review the changes in the merge request ticket (as Gitlab recognizes them automatically) ```git checkout some-feature; git rebase upstream/next-release``` …[add changes]… ```git add -A, git commit --amend; git push -f```