From 9783c5ed69d6d9bb57f2e2c8bf7a97cd9c00412c Mon Sep 17 00:00:00 2001
From: Rodion Promyshlennikov <rpromyshlennikov@mirantis.com>
Date: Fri, 29 Apr 2016 11:03:30 +0300
Subject: [PATCH] Update README

Convert README from rst to markdown format.
Add sub-package for helpers.

Change-Id: Ie27357c8ee2b4b243a0b71e1ec5547d6448e77a6
---
 README.md                            | 58 ++++++++++++++++++++++++++++
 README.rst                           | 23 -----------
 stacklight_tests/helpers/__init__.py |  0
 3 files changed, 58 insertions(+), 23 deletions(-)
 create mode 100644 README.md
 delete mode 100644 README.rst
 create mode 100644 stacklight_tests/helpers/__init__.py

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6a26602
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# Stacklight tests
+
+
+This project based on two other projects:
+
+  * Devops: [Devops documentation](http://docs.fuel-infra.org/fuel-dev/devops.html)
+
+  * Fuel-QA: [Fuel-QA documentation](https://docs.fuel-infra.org/fuel-qa/)
+
+
+## Step-by-step guide:
+
+
+1. Prepare the environment:
+
+  * `vi openrc`
+
+  * `. openrc`
+
+  * `./utils/fuel-qa-builder/prepare_env.sh`
+
+
+2. Run the tests:
+
+  `./utils/jenkins/system_tests.sh -k -K -j fuelweb_test -t test -w $(pwd) -o --group=<your_test_group_to_run>`
+
+  You can read more about on https://docs.fuel-infra.org/fuel-qa/ or
+  run it next way to view help: `./utils/jenkins/system_tests.sh -h`.
+
+
+
+## To contributors:
+
+Please, follow next rules:
+
+* run `tox` or `tox -epep8` before send to review
+
+* try to reuse in dependencies previous deployed environment in
+`@test(depends_on=[<dependency>]`
+(usually basic env is deployed in smoke bvt tests)
+
+* mark test group following next pattern:
+
+ ```
+ @test(groups=["<full_unique_name_of_test>",
+               "<test_method_purpose>",
+               "<plugin_name>",
+               "<test_category>"])
+ ```
+
+ For example:
+
+ ```
+ @test(groups=["install_influxdb_grafana",
+               "install",
+               "influxdb_grafana",
+               "smoke"])
+ ```
\ No newline at end of file
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 74f92cc..0000000
--- a/README.rst
+++ /dev/null
@@ -1,23 +0,0 @@
-Stacklight tests
-----------------
-
-Project based on two other projects:
-  * Devops
-  * Fuel-QA
-
-  [Devops documentation](http://docs.fuel-infra.org/fuel-dev/devops.html)
-  [Fuel-QA documentation](https://docs.fuel-infra.org/fuel-qa/)
-
-
-Step-by-step guide:
--------------------
-
-#. Prepare env:
-  * vi openrc
-  * . openrc
-  * ./utils/fuel-qa-builder/prepare_env.sh
-
-#. Run tests:
-  Use fuel-qa technique, you can read more about it on https://docs.fuel-infra.org/fuel-qa/
-  Basic method to run for developers is:
-  ./utils/jenkins/system_tests.sh -k -K -j fuelweb_test -t test -w $(pwd) -o --group=<your_test_group_to_run>
\ No newline at end of file
diff --git a/stacklight_tests/helpers/__init__.py b/stacklight_tests/helpers/__init__.py
new file mode 100644
index 0000000..e69de29