@@ -24,13 +26,23 @@ title: Developer Resources for Apache CloudStack

If you're a committer on an Apache project, it means that you can commit directly to the project's repository. For instance, with Apache CloudStack committers are allowed to directly push commits into the git repository.

Non-committers, however, have to submit patches for review. Don't worry, it's not an onerous process at all. The first time you submit a patch, it will take a minute or two to create an account on Review Board, but it's a piece of cake from start to finish.

Non-committers, however, have to submit patches for review. Apache CloudStack accepts GitHub pull requests. If you are new to Git and GitHub, check these two links:

GitHub 15 minutes tutorial
Creating Pull Requests

+ +

Apache CloudStack has a read-only mirror on GitHub that is kept in sync with the canonical Git repo maintained by the Apache Software Foundation. Submitting GitHub pull requests is the easiest way to get your contribution upstream. For detailed instructions see the link below:

+ +
GitHub Contribution Guidelines
-

Assumptions

Submitting a patch through JIRA

For the purpose of this post, we'll assume that you already have a system with Git and have found a bug to fix or have a feature that you'd like to submit, and you're willing to contribute that code or documentation under the Apache License 2.0.

While we encourage you to submit your contribution through GitHub pull requests, you can also attach a patch in a JIRA ticket. For the purpose of these instructions, we'll assume that you already have a system with Git and have found a bug to fix or have a feature that you'd like to submit, and you're willing to contribute that code or documentation under the Apache License 2.0.

Further, if you're fixing a bug we'll assume that you've either filed a bug report or are submitting a fix for a known bug. If you find a bug and would like to fix it, that's awesome! Please be sure to file the bug too, though.

Further, if you're fixing a bug we'll assume that you've either filed a bug report (where you will attach your patch) or are submitting a fix for a known bug. If you find a bug and would like to fix it, that's awesome! Please be sure to file the bug too, though.

If you want to add a feature, you should bring it up for discussion on the dev@cloudstack.apache.org mailing list before implementing it. This ensures that it meshes with the plans that other contributors have for Apache CloudStack, and that you're not doing redundant work. Other developers may also have ideas for the feature or suggestions that will help you land the feature without having to re-do the work. More information about our mailing lists can be found here.

@@ -69,45 +81,13 @@ $ git checkout -b mybranch

git commit -m "Insert a meaningful summary of changes here."

Finally, you're going to create a patch to upload to Review Board:

Finally, you can create a patch and attach it to the JIRA issue that you created for the bug you are fixing.

git format-patch master --stdout > ~/patch-name.patch

Using Review Board

- -

Review Board is the main method of sending patches to the Apache CloudStack project. That's not to say that a patch sent directly to the mailing list will be ignored, but the strong preference is that patches be submitted through Review Board. Don't worry, it's a very easy tool to use.

- -

If you haven't already, create an account with Review Board. Registering only requires an email address, first name, and last name. After you're registered, head to New Review Request and select the repository (cloudstack-git) and upload the patch (diff) created with git.

- -

Click Create Review Request and then fill out the information required. Specifically:

- -

Summary
Groups (choose cloudstack)
People (only use if you need specific committers to review changes)
Description
Testing Done

- -

The Summary will be the subject that's sent to the cloudstack-dev mailing list. So if your summary is "fixed feature foo" the subject of the mail sent to the list will be "Review Request: fixed feature foo". Try to be descriptive with the Summary. If you're submitting a patch for a bug, please be sure to include the bug number in the summary. (Like "Bugfix CS-15942: Fixing problem with redundant routers.")

Review

The description should be a full description of what you've done. Please be specific, and include enough information that any reviewer will be able to look at your patch without asking for follow-up information. You need to include the bug ID that your patch relates to as well (ex: CLOUDSTACK-XXX ).

- -

If you're submitting a patch that modifies code, adds features, etc. you should test before submitting. Please be sure to describe your tests here.

- -

Once you're sure everything is OK, go ahead and submit the patch. But that's not the end of the process. The work isn't done until the patch is committed!

- -

Review

- -

Once you've submitted your patch, you should receive a response within a few days. If you receive no response within a week, please ping the cloudstack-dev mailing list. One of the features of Review Board is that shows all of the requests and when they were posted, and the committers know that they should be responsible for reviewing patches in a timely fashion.

- -

When your patch is reviewed, it may be accepted as-is or you may be asked to make changes. If you're asked to make changes, please work with the committer to see the patch through to acceptance.

- -

If the patch is accepted and committed, you have one last task (don't worry, it's minor and kind of satisfying).

- -

Go back to Review Board, click My Dashboard and then Outgoing Reviews. Go to your submission, you should see a "Ship it!" message from the reviewer. Click the Close button and choose Submitted. The status has now changed from pending to submitted.

- -

That's it – you've helped make Apache CloudStack a better project. Thanks!

Once you've submitted your pull request, you should receive a response within a few days. If you receive no response within a week, please ping the cloudstack-dev mailing list (dev@cloudstack.apache.org).

Screencast

@@ -130,7 +110,7 @@ $ git checkout -b mybranch Jira -Reviewboard +Contribution Guidelines ASF Jenkins @@ -183,3 +163,4 @@ git clone https://git-wip-us.apache.org/repos/asf/cloudstack.git