From 3a5a4dab6bafc43e1bf36152ede27e5793980719 Mon Sep 17 00:00:00 2001 From: Shu Muto Date: Wed, 30 Nov 2016 13:35:45 +0900 Subject: [PATCH] Add descriptions for developers and reviewers To setup ui-cookiecutter development environment for developer and reviewer, this patch adds descriptions into CONTRIBUTING.rst. Change-Id: Ifc8a16ba77ce8ea210223de0b842ad4c18f9dbe5 --- CONTRIBUTING.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b550abc..4108b7f 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -15,3 +15,23 @@ Pull requests submitted through GitHub will be ignored. Bugs should be filed on Launchpad, not GitHub: https://bugs.launchpad.net/ui-cookiecutter + + +For developers and reviewers +---------------------------- + +To develop or review ui-cookiecutter, you can setup the environment as follows:: + +#. install cookiecutter + + pip install cookiecutter + +#. clone ui-cookiecutter git repository + + git clone https://github.com/openstack/ui-cookiecutter.git + +#. create change for develop or cherry-pick / checkout for reviewing + +#. generate plugin as follows and check the change + + cookiecutter / [--no-input]