Difference between revisions of "Rally/Develop"
(→How to contribute) |
Jaegerandi (talk | contribs) (→How to contribute) |
||
| Line 20: | Line 20: | ||
=== How to contribute === | === 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'' | :''git clone git@github.com:stackforge/rally.git'' | ||
| − | + | 2. Checkout a new branch to hack on: | |
:''git checkout -b TOPIC-BRANCH'' | :''git checkout -b TOPIC-BRANCH'' | ||
| − | + | 3. Start coding | |
| − | + | 4. Run the test suite locally to make sure nothing broke, e.g.: | |
:''tox'' | :''tox'' | ||
| Line 49: | Line 39: | ||
If you extend Rally with new functionality, make sure you also have provided unit tests for it. | 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'' | :''git commit -a'' | ||
| Line 55: | Line 45: | ||
Make sure you have supplied your commit with a neat commit message, containing a link to the corresponding blueprint / bug, if appropriate. | 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'' | :''git review -R'' | ||
That is the awesome tool we installed earlier that does a lot of hard work for you. | 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)'' | ''(This tutorial is based on: http://www.linuxjedi.co.uk/2012/03/real-way-to-start-hacking-on-openstack.html)'' | ||
Revision as of 18:29, 5 December 2014
Improve Rally
Main directions of work
- Benchmarks. Improvements in the benchmarking engine & developing new benchmark scenarios.
- Deployments. Making Rally able to support multiple cloud deployment facilities, e.g. Fuel.
- CLI. Enriching the command line interface for Rally.
- API. Work around making Rally to be a Benchmark-as-a-Service system & developing rally-pythonclient.
- Incubation. Efforts to make Rally an integrated project in OpenStack.
- Share system. Benchmark results visualization and paste.openstack.org-like sharing system.
- Tempest. Integration of Tempest tests in Rally for deployment verification.
Where to begin
It is extremetly simple to participate in different Rally development lines mentioned above. The Good for start section of our 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 #openstack-rally 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 this article.
How to contribute
Read the 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 review site, it will automatically send your code for a battery of tests on our 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)
