From 9e94200023f8037bfe30f00264e520e3b3ee36ea Mon Sep 17 00:00:00 2001
From: Yih Leong Sun <yihleong@gmail.com>
Date: Thu, 12 Jan 2017 04:22:45 +0000
Subject: [PATCH] add description on how to contribute

Change-Id: I5e056cecbb95d564ff9199e34c83ed7d29bc37df
---
 HACKING.rst | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 README.rst  |  3 +++
 2 files changed, 75 insertions(+), 2 deletions(-)

diff --git a/HACKING.rst b/HACKING.rst
index d4d4fef..b4ebb64 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -1,4 +1,74 @@
 workload-ref-archs Style Commandments
-===============================================
+=====================================
+
+- Read the OpenStack Style Commandments
+  http://docs.openstack.org/developer/hacking/
+
+- Read the `OpenStack Documentation Contributor Guide`_,
+  especially the `Writing style`_, `RST conventions`_
+  and `Diagram guidelines`_
+
+.. _OpenStack Documentation Contributor Guide: http://docs.openstack.org/contributor-guide
+.. _Writing style: http://docs.openstack.org/contributor-guide/writing-style.html
+.. _RST conventions: http://docs.openstack.org/contributor-guide/rst-conv.html
+.. _Diagram guidelines: http://docs.openstack.org/contributor-guide/diagram-guidelines.html
+
+Proposing a new Workload Reference Architecture
+-----------------------------------------------
+
+- Anyone can propose new Workload Reference Architecture
+- Anyone can propose to enhance or modify existing Workload Reference
+  Architecture
+- All proposal will be reviewed by the core team members of Enterprise WG
+
+Submission Process
+------------------
+
+#. Follow the instructions at `First timers <http://docs.openstack.org/contributor-guide/quickstart/first-timers.html>`_
+   to configure a local environment.
+
+#. Clone the repository::
+
+    git clone https://github.com/openstack/workload-ref-archs.git
+
+#. Create a branch for the new workload ::
+
+    git checkout -b <workload-name>
+
+#. Create the following directory structures under `workload-ref-archs <workload-ref-archs>`_
+   for the new workload::
+
+    <workload-name>
+    <workload-name>/<workload-name>.rst
+    <workload-name>/figure
+    <workload-name>/sample/heat
+    <workload-name>/sample/murano
+
+   .. list-table::
+      :widths: 15 25
+
+      * - <workload-name>.rst 
+        - Provides a full description of the workload. 
+          Refer sample.rst for example.
+
+      * - figure
+        - Include all images in this folder
+
+      * - sample/heat
+        - Include sample code for heat (if any)
+
+      * - sample/murano
+        - Include sample code for murano (if any)
+
+#. Commit the changes::
+
+    git commit -a -m "new workload <workload-name>"
+
+#. Submit the changes for review, use the "new-workload" topic for new
+   workload::
+
+    git review -t new-workload
+
+#. The core reviewers of the Workload Reference Architectures team will review
+   the submision.
 
-Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/
diff --git a/README.rst b/README.rst
index 31abb70..298b806 100644
--- a/README.rst
+++ b/README.rst
@@ -17,3 +17,6 @@ architectures and sample code.
 
 .. * Documentation: http://docs.openstack.org/developer/workload-ref-archs
 .. * Source: http://git.openstack.org/cgit/openstack/workload-ref-archs
+
+The `Hacking.rst <HACKING.rst>`_ file contains details on how to contribute
+workload reference architectures.