From 2cb83a5b282369481ad47798e70d5d09e14272b1 Mon Sep 17 00:00:00 2001
From: Greg Herlein <gherlein@herlein.com>
Date: Wed, 6 Jul 2016 09:06:05 -0700
Subject: [PATCH] Added details on exactly how to do documentation patches,
 addressing comments

Change-Id: I9a99b006d8af51e458100597adfd4c808c5b8f58
Partially-implements: blueprint documentation-initialization
---
 doc/source/contributing.rst | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index 49a798b4f..697e597a3 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -22,5 +22,37 @@ under ./doc/build/html.
     # Preview the locally-generated HTML pages within a web browser
     open ./doc/build/html/index.html
 
+    # Create a branch - common branch naming for docs follows the
+    #   blueprint name but this is not enforced
+    git checkout -b bp/documentation-initialization
+
+    # Subsequent independent changes are commonly named
+    #   bp/documentation-initialization-X
+    #   where X is monotomically increasing
+    # Edits to the same commit use 'git commit --amend'
+
+    # Verify the scope of your changes is to the files you modified
+    git status
+
+    # Ensure that the commit message references the blueprint
+    # by adding this line to the commit message:
+    # Partially-implements: blueprint documentation-initialization
+
+    # OpenStack docs suggest 'git commit -a' but be careful
+    #   safer bet is to commit the file and then use 'git status' to check
+    git commit <file>
+
+    # If it's a change to prior commit use 'git commit --amend'
+    #   and don't edit the changeID
+
+    # Check your changes are as you intend
+    git show
+
+    # Check it in
+    git review
+
+    # Go back to the master branch
+    git checkout master
+
 .. _reStructuredText: http://docutils.sourceforge.net/rst.html