From 8daaa2695f8192610499ffc082d8030fe387ea93 Mon Sep 17 00:00:00 2001
From: Thomas Draebing <thomas.draebing@sap.com>
Date: Wed, 11 Mar 2020 14:15:33 +0100
Subject: [PATCH] Add basic dev documentation

Change-Id: I6de025c38fa87d4b70bdd4d8eaf261ced97716f2
---
 .github/PULL_REQUEST_TEMPLATE.md |  9 ++++++++
 documentation/developer-guide.md | 37 ++++++++++++++++++++++++++++++++
 2 files changed, 46 insertions(+)
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 create mode 100644 documentation/developer-guide.md

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..fd8a1af
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,9 @@
+# Important Notice
+
+Patch submission and review is done through
+[Gerrit Code Review](https://gerrit-review.googlesource.com).
+Unfortunately we cannot pull your code as a Pull Request.
+
+__NO REVIEWS OR DISCUSSIONS will happen on GitHub__, all the
+[code collaboration](../Documentation/developer-guide.md)
+will take place on Gerrit.
diff --git a/documentation/developer-guide.md b/documentation/developer-guide.md
new file mode 100644
index 0000000..f001331
--- /dev/null
+++ b/documentation/developer-guide.md
@@ -0,0 +1,37 @@
+# Developer Guide
+
+[TOC]
+
+## Code Review
+
+This project uses Gerrit for code review:
+https://gerrit-review.googlesource.com/
+which uses the ["git push" workflow][1] with server
+https://gerrit.googlesource.com/gerrit-monitoring. You will need a
+[generated cookie][2].
+
+[1]: https://gerrit-review.googlesource.com/Documentation/user-upload.html#_git_push
+[2]: https://gerrit.googlesource.com/new-password
+
+Gerrit depends on "Change-Id" annotations in your commit message.
+If you try to push a commit without one, it will explain how to
+install the proper git-hook:
+
+```
+curl -Lo `git rev-parse --git-dir`/hooks/commit-msg \
+    https://gerrit-review.googlesource.com/tools/hooks/commit-msg
+chmod +x `git rev-parse --git-dir`/hooks/commit-msg
+```
+
+Before you create your local commit (which you'll push to Gerrit)
+you will need to set your email to match your Gerrit account:
+
+```
+git config --local --add user.email foo@bar.com
+```
+
+Normally you will create code reviews by pushing for master:
+
+```
+git push origin HEAD:refs/for/master
+```