[tz] [PATCH] * CONTRIBUTING: New file.

Paul Eggert eggert at cs.ucla.edu
Wed Aug 13 15:16:58 UTC 2014


walter harms wrote:
> I am not a git expert, so when i read this i would assume to start
> with git clone again.

Thanks, I meant step 2 again.  If you're using "git fetch" you have more 
git expertise than the intended audience; "git fetch" is the "right way" 
but requires more explanation for new users and is probably overkill 
here, where the idea is to always make changes in a private branch. 
CONTRIBUTING has the usual tension between not scaring off new users and 
explaining things for experts, but if someone uses this workflow often 
enough to need to worry about branch management they should be enough of 
a git expert by then to figure things out on their own....

Anyway, sorry about the ramble, I hope the attached patch clears things up.
-------------- next part --------------
From 0f4a8f01fc6c0843cc81850271078ff242cdaffb Mon Sep 17 00:00:00 2001
From: Paul Eggert <eggert at cs.ucla.edu>
Date: Wed, 13 Aug 2014 08:02:56 -0700
Subject: [PATCH] * CONTRIBUTING: Clarify how to repeat the git workflow.

* NEWS: Thanks.
---
 CONTRIBUTING | 6 ++++--
 NEWS         | 4 ++--
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 508071b..5586ec8 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -31,7 +31,8 @@ Git repository.  If you use Git the following workflow may be helpful:
       git checkout master
       git pull
 
-  * Switch to a new branch for the changes.
+  * Switch to a new branch for the changes.  Choose a different
+    branch name for each change set.
 
       git checkout -b mybranch
 
@@ -60,7 +61,8 @@ Git repository.  If you use Git the following workflow may be helpful:
 
       git send-email master
 
-  * Start anew by getting current with the master branch again.
+  * Start anew by getting current with the master branch again
+    (the second step above).
 
 Please do not create issues or pull requests on Github, as the
 proper procedure for proposing and distributing patches is via
diff --git a/NEWS b/NEWS
index f7033cc..8670c3a 100644
--- a/NEWS
+++ b/NEWS
@@ -52,8 +52,8 @@ Unreleased, experimental changes
 
   Changes affecting documentation and commentary
 
-    A new file CONTRIBUTING is distributed.  (Thanks to Tim Parenti
-    for suggesting a CONTRIBUTING file.)
+    A new file CONTRIBUTING is distributed.  (Thanks to Tim Parenti for
+    suggesting a CONTRIBUTING file, and to Walter Harms for debugging it.)
 
     tz-link.htm mentions Windows Runtime etc. (thanks to Matt Johnson)
     and HP-UX's tztab.
-- 
1.9.1


More information about the tz mailing list