From 924505b3a41b55c209b6935fb69bf5642ed03d11 Mon Sep 17 00:00:00 2001
From: Simon Pasquier <spasquier@mirantis.com>
Date: Fri, 29 Apr 2016 11:35:18 +0200
Subject: [PATCH] Update README

Change-Id: I8b6f3b3f697b9c9464849e5073c611c86449737d
---
 README.md | 82 ++++++++++++++++++++++++++++++-------------------------
 1 file changed, 45 insertions(+), 37 deletions(-)

diff --git a/README.md b/README.md
index 6a26602..40b2871 100644
--- a/README.md
+++ b/README.md
@@ -1,58 +1,66 @@
-# Stacklight tests
+# StackLight tests
 
+This project contains the functional tests for the [StackLight](https://launchpad.net/lma-toolchain) plugins.
 
-This project based on two other projects:
+It is based on two other projects:
 
-  * Devops: [Devops documentation](http://docs.fuel-infra.org/fuel-dev/devops.html)
+  * Fuel-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:
+  * Fuel-QA ([documentation](https://docs.fuel-infra.org/fuel-qa/)).
 
+## Getting started
 
 1. Prepare the environment:
 
-  * `vi openrc`
-
-  * `. openrc`
-
-  * `./utils/fuel-qa-builder/prepare_env.sh`
-
+```
+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>`
+```
+./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`.
+## Contributing
 
+If you would like to contribute to the development of this plugin,
+you must follow the [OpenStack development workflow](
+http://docs.openstack.org/infra/manual/developers.html#development-workflow)
+instructions.
 
+Patch reviews take place on the [OpenStack Gerrit](
+https://review.openstack.org/#/q/status:open+project:openstack/fuel-plugin-lma-collector,n,z)
+system.
 
-## To contributors:
+Guidelines:
 
-Please, follow next rules:
+* Run `tox` before submitting a review.
 
-* run `tox` or `tox -epep8` before send to review
+* Declare test groups using the following pattern:
 
-* 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>"])
- ```
+```
+@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
+```
+@test(groups=["install_influxdb_grafana",
+              "install",
+              "influxdb_grafana",
+              "smoke"])
+```
+
+## Communication
+
+The *OpenStack Development Mailing List* is the preferred way to communicate
+with the members of the project.
+Emails should be sent to `openstack-dev@lists.openstack.org` with the subject
+prefixed by `[fuel][plugins][lma]`.
+