This page is intended to help new developers get up to speed, and contribute to the project
Background
A brief introduction is here
Who-is-Who
To help you know who is the right person to reach out to - http://cloudstack.apache.org/who.html
Before getting to code
Understanding the environment
- Git is used for source control management. If you are new to git, this link will be helpful. The project is hosted on GitHub
- Java is the primary development language
- MySQL is used as a datastore
- The testing framework is in Python
- Jenkins is used for Continuous-Integration
- Eclipse is the commonly used IDE by developers
- Useful mailing lists for the project (For starters, sign up for users, dev and announce mailing lists)
- Review mailing conventions followed. Use Markmail links when pinning specific mail threads
- Get accounts on
- https://wiki.apache.org to be able to edit this Wiki
- http://issues.apache.org for JIRA access (Tip - Add CLOUDSTACK as your project)
- https://reviews.apache.org/ for requesting reviews to your patch
- Review the guidelines at project bylaws . Please make sure you understand the roles, get an idea of where you fall (user, contributor, committer etc.). Take the time to understand the review process mentioned there.
- The coding conventions to be followed
- Links to set-up your dev environment (includes link to set-up Eclipse) : https://cwiki.apache.org/confluence/display/CLOUDSTACK/Setting+up+CloudStack+Development+Environment
- To help you develop on a single dev machine, you may use DevCloud. More details here
- If you plan to use Eclipse, an Eclipse profile to adhere to coding conventions can be found under tools/eclipse/eclipse.epf
- CloudStack uses Marvin (a python-based framework) for testing. Every developer is encouraged and expected to contribute to the tests. You can set-up your environment following this link : https://cwiki.apache.org/confluence/display/CLOUDSTACK/Marvin+-+Testing+with+Python#Marvin-TestingwithPython-PythonResources
- To create a patch, read this link (non-committers)
- Review request guidelines can be found here
Understanding the terminologies
- An excellent presentation to start with is : http://www.slideshare.net/cloudstack/cloudstack-architecture
- Refer to slide 15 on above presentation to understand zones, pods, clusters, primary storage and secondary storage
- More detailed information at https://cwiki.apache.org/confluence/display/CLOUDSTACK/Development+101
Project workings
The project follows a 4-month release cycle. As of July 2013, the latest scheduled release is 4.2.
More details can be found at : https://cwiki.apache.org/confluence/display/CLOUDSTACK/Releases
Overview
Content Tools
Apps