You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by bu...@apache.org on 2011/10/29 02:05:12 UTC
svn commit: r797642 -
/websites/staging/libcloud/trunk/content/contributing.html
Author: buildbot
Date: Sat Oct 29 00:05:12 2011
New Revision: 797642
Log:
Staging update by buildbot
Modified:
websites/staging/libcloud/trunk/content/contributing.html
Modified: websites/staging/libcloud/trunk/content/contributing.html
==============================================================================
--- websites/staging/libcloud/trunk/content/contributing.html (original)
+++ websites/staging/libcloud/trunk/content/contributing.html Sat Oct 29 00:05:12 2011
@@ -79,6 +79,7 @@
<p>This pages explains how you can contribute to the libcloud project.</p>
<p>Keep in mind that all kind of contributions are welcome (ideas, code, tests, documentation, examples, ...).</p>
<h3 id="process">Process</h3>
+
<ol>
<li>Start a discussion on the <a href="devinfo.html">mailing list</a> (this step is optional and only required if you want to implement big feature or a change)</li>
<li>Open a new issue on the <a href="https://issues.apache.org/jira/browse/LIBCLOUD">bug tracker</a> (Jira)</li>
@@ -93,13 +94,15 @@
<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>
+<h3 id="things_to_keep_in_mind">Things To Keep In Mind</h3>
+
<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>
<li>We follow <a href="http://www.python.org/dev/peps/pep-0008/">PEP8 Python Style Guide</a></li>
<li>Use 4 spaces for a tab</li>