|
|
| (2 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| − | == Improve Rally ==
| |
| | | | |
| − | === Main directions of work ===
| + | The page has been moved to https://rally.readthedocs.io |
| − | | |
| − | To track main directions of work you can take a look at rally road map [http://document https://docs.google.com/a/mirantis.com/spreadsheets/d/16DXpfbqvlzMFaqaXAcJsBzzpowb_XpymaK2aFY2gA2g/edit#gid=0]
| |
| − | | |
| − | === Where to begin ===
| |
| − | It is extremetly simple to participate in different Rally development lines mentioned above. The '''''Good for start''''' section of our '''[https://trello.com/b/DoD8aeZy/rally Trello board]''' contains a wide range of tasks perfectly suited for you to quickly and smoothly start contributing to Rally. As soon as you have chosen a task, just log in to Trello, join the corresponding card and move it to the '''''In progress''''' section.
| |
| − | | |
| − | The most Trello cards contain basic descriptions of what is to be done there; in case you have questions or want to share your ideas, be sure to contanct us at the <code><nowiki>#openstack-rally</nowiki></code> IRC channel on '''irc.freenode.net'''.
| |
| − | | |
| − | If you want to grasp a better understanding of several main design concepts used throughout the Rally code (such as '''''benchmark scenarios''''', '''''contexts''''' etc.), please read '''[[Rally/Concepts|this article]]'''.
| |
| − | | |
| − | | |
| − | === How to contribute ===
| |
| − | | |
| − | Read the [http://docs.openstack.org/infra/manual/developers.html Developer's Guide] on how to setup the account and git and then continue with:
| |
| − | | |
| − | 1. Grab the Rally repository:
| |
| − | :''git clone git@github.com:stackforge/rally.git''
| |
| − | | |
| − | 2. Checkout a new branch to hack on:
| |
| − | | |
| − | :''git checkout -b TOPIC-BRANCH''
| |
| − | | |
| − | 3. Start coding
| |
| − | | |
| − | 4. Run the test suite locally to make sure nothing broke, e.g.:
| |
| − | :''tox''
| |
| − | | |
| − | (NOTE you should have installed tox<=1.6.1 )
| |
| − | | |
| − | If you extend Rally with new functionality, make sure you also have provided unit tests for it.
| |
| − | | |
| − | 5. Commit your work using:
| |
| − | :''git commit -a''
| |
| − | | |
| − | | |
| − | Make sure you have supplied your commit with a neat commit message, containing a link to the corresponding blueprint / bug, if appropriate.
| |
| − | | |
| − | 6. Push the commit up for code review using:
| |
| − | :''git review -R''
| |
| − | | |
| − | That is the awesome tool we installed earlier that does a lot of hard work for you.
| |
| − | | |
| − | 7. Watch your email or [http://review.openstack.org/ review site], it will automatically send your code for a battery of tests on our [http://jenkins.openstack.org/ Jenkins setup] and the core team for the project will review your code. If there are any changes that should be made they will let you know.
| |
| − | | |
| − | 8. When all is good the review site will automatically merge your code.
| |
| − | | |
| − | | |
| − | | |
| − | ''(This tutorial is based on: http://www.linuxjedi.co.uk/2012/03/real-way-to-start-hacking-on-openstack.html)''
| |
