From 3c964c51e7c4ac34e03104e2f6d3e668efa583df Mon Sep 17 00:00:00 2001
From: William Brown <william@blackhats.net.au>
Date: Fri, 22 Mar 2019 10:09:05 +1000
Subject: [PATCH] Add some git instructions

---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

diff --git a/README.md b/README.md
index e83e3d0f2..c95274eea 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,66 @@ See CODE_OF_CONDUCT.md
 
 ## Get involved
 
+To get started, you'll need to fork or branch, and we'll merge based on PR's.
+
+If you are a contributor to the project, simply clone:
+
+```
+git clone git@github.com:Firstyear/kanidm.git
+```
+
+If you are forking, then Fork in github and clone with:
+
+```
+git clone https://github.com/Firstyear/kanidm.git
+cd kanidm
+git remote add myfork git@github.com:<YOUR USERNAME>/kanidm.git
+```
+
+Select and issue (and always feel free to reach out to us for advice!), and create a branch to
+start working:
+
+```
+git branch <feature-branch-name>
+git checkout <feature-branche-name>
+```
+
+When you are ready for review (even if the feature isn't complete and you just want some advice)
+
+```
+git commit -m 'Commit message' change_file.rs ...
+git push <myfork/origin> <feature-branch-name>
+```
+
+If you get advice or make changes, just keep commiting to the branch, and pushing to your branch.
+When we are happy with the code, we'll merge in github, meaning you can now cleanup your branch.
+
+```
+git checkout master
+git pull
+git branch -D <feature-branch-name>
+```
+
+Rebasing:
+
+If you are asked to rebase your change, follow these steps:
+
+```
+git checkout master
+git pull
+git checkout <feature-branche-name>
+git rebase master
+```
+
+Then be sure to fix any merge issues or other comments as they arise. If you have issues, you can
+always stop and reset with:
+
+```
+git rebase --abort
+```
+
+
+
 ## Designs
 
 See the designs folder