You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2011/10/29 02:01:39 UTC
svn commit: r797641 - in /websites/production/libcloud: ./
content/contributing.html
Author: tomaz
Date: Sat Oct 29 00:01:38 2011
New Revision: 797641
Log:
Publishing merge to libcloud site by tomaz
Modified:
websites/production/libcloud/ (props changed)
websites/production/libcloud/content/contributing.html
Propchange: websites/production/libcloud/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Sat Oct 29 00:01:38 2011
@@ -1 +1 @@
-/websites/staging/libcloud/trunk:787380-797638
+/websites/staging/libcloud/trunk:787380-797640
Modified: websites/production/libcloud/content/contributing.html
==============================================================================
--- websites/production/libcloud/content/contributing.html (original)
+++ websites/production/libcloud/content/contributing.html Sat Oct 29 00:01:38 2011
@@ -93,6 +93,11 @@
<li>Attach patch to the ticket you have created</li>
<li>Wait for your patch to be reviewed and / or accepted</li>
</ol>
+<h4 id="things_to_keep_in_mind">Things To Keep In Mind</h4>
+<ul>
+<li>Any non-trivial change must contain tests</li>
+<li>All the functions and methods must contain <a href="http://codespeak.net/~mwh/pydoctor/">pydoc</a> docstrings which are used to generate API documentation. You can find a lot of examples of docstrings in the existing code e.g. - <code>libcloud/compute/base.py</code></li>
+</ul>
<p><em>Note: If you want you can also use SVN repository, but git and github make branching and contributing a bit easier.</em></p>
<h3 id="style_guide">Style Guide</h3>
<ol>