Added workflow documentation

armchairdj · Jul 31, 2010 · 9b61949 · 9b61949
1 parent 8001dfd
commit 9b61949
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -7,7 +7,6 @@ coverage
 rdoc
 pkg
 tmp
-doc
 log
 .yardoc
 measurements

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,9 +5,3 @@
 ### 0.0.1, released 2010-07-30
 
 * Initial setup
-
-#### Notes
-
-* h1 for major release
-* h2 for minor release
-* h3 for patch release
diff --git a/doc/workflow.md b/doc/workflow.md
@@ -0,0 +1,17 @@
+# Workflow to Maintain This Gem
+
+1. Update code and commit it.
+2. Bump the version with one of the rake tasks:
+   * @rake version:bump:patch@ 1.5.3 -> 1.5.4
+   * @rake version:bump:minor@ 1.5.3 -> 1.6.0
+   * @rake version:bump:major@ 1.5.3 -> 2.0.0
+   * @rake version:write MAJOR=2 MINOR=3 PATCH=6@ 1.5.3 -> 2.3.6
+3. Add entry to CHANGELOG:
+   * h1 for major release
+   * h2 for minor release
+   * h3 for patch release
+4. Release it.
+   * @rake release@
+   * Optionally release it to [[Rubyforge]]: @rake rubyforge:release@
+   * Optionally release it to [[Gemcutter]]: @rake gemcutter:release@
+5. Rinse and repeat
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,6 @@ coverage @@
     rdoc
     pkg
     tmp
-    doc
     log
     .yardoc
     measurements
@@ Expand Down @@