libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From to...@apache.org
Subject svn commit: r1493306 - /libcloud/site/trunk/content/contributing.mdtext
Date Sat, 15 Jun 2013 04:19:32 GMT
Author: tomaz
Date: Sat Jun 15 04:19:31 2013
New Revision: 1493306

URL: http://svn.apache.org/r1493306
Log:
Update contributing page.

Modified:
    libcloud/site/trunk/content/contributing.mdtext

Modified: libcloud/site/trunk/content/contributing.mdtext
URL: http://svn.apache.org/viewvc/libcloud/site/trunk/content/contributing.mdtext?rev=1493306&r1=1493305&r2=1493306&view=diff
==============================================================================
--- libcloud/site/trunk/content/contributing.mdtext (original)
+++ libcloud/site/trunk/content/contributing.mdtext Sat Jun 15 04:19:31 2013
@@ -1,37 +1,40 @@
 Title: Contributing
 
-## Contributing to libcloud ##
+## Contributing to Libcloud
 
-This pages explains how you can contribute to the libcloud project.
+We welcome contributions of any kind (ideas, code, tests, documentation,
+examples, ...).
 
-Keep in mind that all kind of contributions are welcome (ideas, code, tests,
-documentation, examples, ...).
-
-<h3 id="process"><a href="#process">Process</a></h3>
-
-1. Start a discussion on the [mailing list](devinfo.html) (this step is
-optional and only required if you want to implement big feature or a change)
-2. Open a new issue on the
-[bug tracker](https://issues.apache.org/jira/browse/LIBCLOUD) (JIRA)
-3. Fork libcloud [github git repository](https://github.com/apache/libcloud)*
+This page explains how you can contribute to the Libcloud project. If you get
+stuck at any point during this process, stop by on our IRC channel (#libcloud
+on freenode) and we will do our best to help you.
+
+<h3 id="process"><a href="#process">General workflow</a></h3>
+
+1. If you are implementing a big feature or a change, start a discussion on
+the [mailing list](devinfo.html) first.
+2. Open a new issue on our
+[issue tracker](https://issues.apache.org/jira/browse/LIBCLOUD) (JIRA)
+3. Fork libcloud [Github git repository](https://github.com/apache/libcloud)*
 and make your changes
  1. Create a new branch for your changes:
-  `git checkout -b jira_issue_id_change_name`
+  `git checkout -b <jira_issue_id>_<change_name>`
  2. Make your changes
-4. Write tests for your modifications and make sure that all the tests still
-pass. For more informations about running the tests refer to the
+4. Write tests for your modifications and make sure that all the tests pass.
+For more information about running the tests refer to the
 [Testing](/testing.html) page.
-5. Create a patch with your changes
- 1. git (format-patch):
- `git format-patch --no-prefix --stdout trunk > patch_name.patch`
- 2. git (diff):
- `git diff --no-prefix trunk your_branch > patch_name.patch`
- 3. svn: `svn diff > patch_name.patch`
-6. Attach patch to the ticket you have created
-7. Wait for your patch to be reviewed and iterate on any potential feedback
-
-*Note: If you want you can also use SVN repository, but git and github make
-branching and contributing a bit easier.*
+5. Open a pull request with your changes. Your pull request will appear at
+https://github.com/apache/libcloud/pulls
+6. Wait for the code to be reviewed and address any outstanding comments.
+7. Once the code has been reviewed, all the outstanding issues have been
+addressed and the pull request has been ACK'ed, close the pull request,
+generate a patch and attach it to the JIRA issue you have created earlier:
+ `git format-patch --stdout trunk > patch_name.patch`
+
+Note: We use Github only for pull requests and code review. Once a pull request
+has been reviewed, all the comments have been addresses and it's ready to be
+merged, user who submitted the pull request must close the pull request, create
+a patch and attach it to the original JIRA ticket.
 
 <h3 id="things_to_keep_in_mind"><a href="#things_to_keep_in_mind">Things To Keep
In Mind</a></h3>
 



Mime
View raw message