From: Michal Sojka <michal.sojka@cvut.cz>
Date: Sun, 2 Sep 2018 20:49:36 +0000 (+0200)
Subject: README: Document where and how to send patches
X-Git-Url: http://rtime.felk.cvut.cz/gitweb/coffee/main.git/commitdiff_plain/055b96a7181b8fd5e86a5ee8d1b0ed82fb3f1199

README: Document where and how to send patches
---

diff --git a/README.md b/README.md
index e383e13..67c43e3 100644
--- a/README.md
+++ b/README.md
@@ -43,3 +43,16 @@ Then compile and run all the software components:
 5. Pressing keys in _mtaio_ window simulates various activities.
    Numbers are cards of different users, letters A through F are
    different coffee machine buttons.
+
+### Submitting patches
+
+Send patches by email (preferably with [git send-email][]) to
+`coffee@rtime.felk.cvut.cz` [mailing list][]. You can subscribe the
+[mailing list][] to discuss the patches sent by others.
+
+It is recommended to run the [`setup_git`][sg] script in your local
+repository to configure git optimally for patch submission.
+
+[git send-email]: https://rtime.felk.cvut.cz/wiki/index.php/Configuring_git_send-email
+[mailing list]: https://rtime.felk.cvut.cz/mailman/listinfo/coffee
+[sg]: main.git/blob/HEAD:/setup_git
diff --git a/setup_git b/setup_git
new file mode 100755
index 0000000..710f255
--- /dev/null
+++ b/setup_git
@@ -0,0 +1,10 @@
+#!/bin/sh
+
+set -e
+
+cd $(dirname "$0")
+
+git submodule foreach '
+    git config sendemail.to coffee@rtime.felk.cvut.cz
+    git config format.subjectPrefix "PATCH $(basename $sm_path)"
+'