Recent changes to Workflow

Workflow modified by David A. Wheeler

David A. Wheeler — Fri, 27 Sep 2013 03:10:39 -0000

--- v17
+++ v18
@@ -25,7 +25,7 @@
     git checkout develop
     git merge --no-ff master
     vi configure.ac # Change version number to "to be".  Edit other files per configure.ac.
-    git -a commit
+    git commit -a
     git push origin master
     git push origin develop
     git push --tags

Workflow modified by David A. Wheeler

David A. Wheeler — Fri, 27 Sep 2013 03:07:40 -0000

--- v16
+++ v17
@@ -16,6 +16,7 @@
     git commit -a
     git checkout master
     git merge --no-ff develop
+    autoreconf -i && ./configure
     make distcheck  # Make sure it works first!
     git commit -a
     # Version numbers must be of form MAJOR.MINOR.PATCH; version tags have "v" in front.

Workflow modified by David A. Wheeler

David A. Wheeler — Tue, 27 Aug 2013 12:37:54 -0000

--- v15
+++ v16
@@ -30,7 +30,6 @@
     git push --tags
     # Post the new .tar.gz

-Ideally that'd be it, but after posting the wrong "current" version may be linked in the files section.  Fix this by following this process:
-http://sourceforge.net/p/forge/site-support/5166/
+Make sure that the newest file in the "Files" directory (other than README) is the default download.  If it isn't, fix this using this process: http://sourceforge.net/p/forge/site-support/5166/

 We need to implement readers, of course, but also pretty-printers, editor macros, packages, and so on so they can be widely deployed.  For code that implements these the MIT license is preferred, so that they can be spread widely.  We'd love help!

Workflow modified by David A. Wheeler

David A. Wheeler — Tue, 27 Aug 2013 12:33:48 -0000

--- v14
+++ v15
@@ -11,20 +11,26 @@
 On release, the release manager merges multi-commits for a feature with:
  "git checkout master; git merge --no-ff develop" so it's clear that the commits are a set (and their origins aren't obscured).  After "make distcheck" works, then "git tag -a TAG_NUMBER -am MESSAGE".

-    vi configure.ac # Change version number
+    vi configure.ac # Change version number, if it will be different
     vi ChangeLog
     git commit -a
     git checkout master
     git merge --no-ff develop
     make distcheck  # Make sure it works first!
     git commit -a
+    # Version numbers must be of form MAJOR.MINOR.PATCH; version tags have "v" in front.
     git tag -a VERSION_NUMBER -am "Version VERSION_NUMBER - REASON"
     make dist # For posting of a .tar.gz
     git checkout develop
     git merge --no-ff master
+    vi configure.ac # Change version number to "to be".  Edit other files per configure.ac.
+    git -a commit
     git push origin master
     git push origin develop
     git push --tags
     # Post the new .tar.gz

+Ideally that'd be it, but after posting the wrong "current" version may be linked in the files section.  Fix this by following this process:
+http://sourceforge.net/p/forge/site-support/5166/
+
 We need to implement readers, of course, but also pretty-printers, editor macros, packages, and so on so they can be widely deployed.  For code that implements these the MIT license is preferred, so that they can be spread widely.  We'd love help!

Workflow modified by David A. Wheeler

David A. Wheeler — Sun, 25 Aug 2013 16:50:05 -0000

--- v13
+++ v14
@@ -1,4 +1,4 @@
-For our draft (development) code, see the [readable code git repository](https://sourceforge.net/p/readable/code).
+For our draft (development) code, see the [readable code git repository](https://sourceforge.net/p/readable/code).  The easy way to start contributing code is to select the "develop" branch (not the "master" branch) and fork it; when you're done, submit a push request.

 We use [Vincent Driessen's "successful git branching model" workflow](http://nvie.com/posts/a-successful-git-branching-model/); [git workflow shows sample commands](http://skoch.github.com/Git-Workflow/), and [Development Workflow](http://code.google.com/p/mdanalysis/wiki/DevelopmentWorkflow) gives another view. This means that  "origin/develop" is the latest "integration branch" of development, while "origin/master" is the latest *production* release.

Workflow modified by David A. Wheeler

David A. Wheeler — Mon, 17 Jun 2013 23:50:31 -0000

--- v12
+++ v13
@@ -11,9 +11,11 @@
 On release, the release manager merges multi-commits for a feature with:
  "git checkout master; git merge --no-ff develop" so it's clear that the commits are a set (and their origins aren't obscured).  After "make distcheck" works, then "git tag -a TAG_NUMBER -am MESSAGE".

+    vi configure.ac # Change version number
+    vi ChangeLog
+    git commit -a
     git checkout master
     git merge --no-ff develop
-    vi configure.ac # Change version number
     make distcheck  # Make sure it works first!
     git commit -a
     git tag -a VERSION_NUMBER -am "Version VERSION_NUMBER - REASON"

WikiPage Workflow modified by David A. Wheeler

David A. Wheeler — Sun, 10 Mar 2013 01:43:52 -0000

--- v11
+++ v12
@@ -15,6 +15,7 @@
     git merge --no-ff develop
     vi configure.ac # Change version number
     make distcheck  # Make sure it works first!
+    git commit -a
     git tag -a VERSION_NUMBER -am "Version VERSION_NUMBER - REASON"
     make dist # For posting of a .tar.gz
     git checkout develop

WikiPage Workflow modified by David A. Wheeler

David A. Wheeler — Sun, 10 Mar 2013 01:43:20 -0000

--- v10
+++ v11
@@ -13,6 +13,7 @@

     git checkout master
     git merge --no-ff develop
+    vi configure.ac # Change version number
     make distcheck  # Make sure it works first!
     git tag -a VERSION_NUMBER -am "Version VERSION_NUMBER - REASON"
     make dist # For posting of a .tar.gz

WikiPage Workflow modified by David A. Wheeler

David A. Wheeler — Sun, 25 Nov 2012 23:26:32 -0000

--- v9
+++ v10
@@ -6,6 +6,8 @@
 
 To contribute, please post where to pull the information, or post a bundle.
 
+If you rename files, please *just* rename the file using `git mv`, *without* editing anything, and then save that as a separate commit.  Git does not track file renames (per a decision by Linus Torvalds that David A. Wheeler thinks is completely wrong-headed), and as a result, "git diff" results are sometimes scrambled if you rename and edit in the same commit.  If you ensure that a commit does *only* renames, or *only* edits and file additions, you're fine.
+
 On release, the release manager merges multi-commits for a feature with:
  "git checkout master; git merge --no-ff develop" so it's clear that the commits are a set (and their origins aren't obscured).  After "make distcheck" works, then "git tag -a TAG_NUMBER -am MESSAGE".
 
@@ -13,12 +15,12 @@
     git merge --no-ff develop
     make distcheck  # Make sure it works first!
     git tag -a VERSION_NUMBER -am "Version VERSION_NUMBER - REASON"
+    make dist # For posting of a .tar.gz
     git checkout develop
     git merge --no-ff master
     git push origin master
     git push origin develop
     git push --tags
-
-If you rename files, please *just* rename the file using `git mv`, *without* editing anything, and then save that as a separate commit.  Git does not track file renames (per a decision by Linus Torvalds that David A. Wheeler thinks is completely wrong-headed), and as a result, "git diff" results are sometimes scrambled if you rename and edit in the same commit.  If you ensure that a commit does *only* renames, or *only* edits and file additions, you're fine.
+    # Post the new .tar.gz
 
 We need to implement readers, of course, but also pretty-printers, editor macros, packages, and so on so they can be widely deployed.  For code that implements these the MIT license is preferred, so that they can be spread widely.  We'd love help!

WikiPage Workflow modified by David A. Wheeler

David A. Wheeler — Sun, 25 Nov 2012 23:16:34 -0000

--- v8
+++ v9
@@ -4,10 +4,21 @@
 
 You can get the "develop" branch with "git checkout -b develop origin/develop". Features are created in feature branches, merged back to origin/develop, and eventually to origin/master for release.
 
-On release, the release manager merges multi-commits for a feature with "git checkout master; git merge --no-ff develop" so it's clear that the commits are a set (and their origins aren't obscured).  After "make distcheck" works, then "git tag -a TAG_NUMBER -am MESSAGE".
-
 To contribute, please post where to pull the information, or post a bundle.
 
-If you rename files, please *just* rename the file using `git mv`, *without* editing anything, and then save that as a separate commit.  Git does not track file renames (per a decision by Linus Torvalds that David A. Wheeler thinks is completely wrong-headed), and as a result, "git diff" results are completely scrambled if you rename and edit in the same commit.  If you ensure that a commit does *only* renames, or *only* edits and file additions, you're fine.
+On release, the release manager merges multi-commits for a feature with:
+ "git checkout master; git merge --no-ff develop" so it's clear that the commits are a set (and their origins aren't obscured).  After "make distcheck" works, then "git tag -a TAG_NUMBER -am MESSAGE".
+
+    git checkout master
+    git merge --no-ff develop
+    make distcheck  # Make sure it works first!
+    git tag -a VERSION_NUMBER -am "Version VERSION_NUMBER - REASON"
+    git checkout develop
+    git merge --no-ff master
+    git push origin master
+    git push origin develop
+    git push --tags
+
+If you rename files, please *just* rename the file using `git mv`, *without* editing anything, and then save that as a separate commit.  Git does not track file renames (per a decision by Linus Torvalds that David A. Wheeler thinks is completely wrong-headed), and as a result, "git diff" results are sometimes scrambled if you rename and edit in the same commit.  If you ensure that a commit does *only* renames, or *only* edits and file additions, you're fine.
 
 We need to implement readers, of course, but also pretty-printers, editor macros, packages, and so on so they can be widely deployed.  For code that implements these the MIT license is preferred, so that they can be spread widely.  We'd love help!