givi - Explain workfow assumptions in help text

diff --git a/bin/givi b/bin/givi
index 643ad9d9f3f22e627e1fc44281cdb18e160dc9ef..b18d9b1f4ba621cddf9b20876618426da71bfdeb 100755 (executable)
--- a/bin/givi
+++ b/bin/givi
@@ -192,6 +192,11 @@ class Givi {
   function doHelp() {
     $program = basename($this->program);
     echo "Givi - Coordinate git checkouts across CiviCRM repositories\n";
+    echo "Scenario:\n";
+    echo "  You have cloned and forked the CiviCRM repos. Each of the repos has two\n";
+    echo "  remotes (origin + upstream). When working on a new PR, you generally want\n";
+    echo "  to checkout official code (eg upstream/master) in all repos, but 1-2 repos\n";
+    echo "  should use a custom branch (which tracks upstream/master).\n";
     echo "Usage:\n";
     echo "  $program [options] checkout <branch>\n";
     echo "  $program [options] fetch\n";