libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r864803 - in /websites/staging/libcloud/trunk/content: ./ contributing.html
Date Sat, 08 Jun 2013 04:32:57 GMT
Author: buildbot
Date: Sat Jun  8 04:32:57 2013
New Revision: 864803

Log:
Staging update by buildbot for libcloud

Modified:
    websites/staging/libcloud/trunk/content/   (props changed)
    websites/staging/libcloud/trunk/content/contributing.html

Propchange: websites/staging/libcloud/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sat Jun  8 04:32:57 2013
@@ -1 +1 @@
-1490911
+1490915

Modified: websites/staging/libcloud/trunk/content/contributing.html
==============================================================================
--- websites/staging/libcloud/trunk/content/contributing.html (original)
+++ websites/staging/libcloud/trunk/content/contributing.html Sat Jun  8 04:32:57 2013
@@ -104,28 +104,40 @@
       
       <h2 id="contributing-to-libcloud">Contributing to libcloud</h2>
 <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>
+<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>
-<li>Fork libcloud <a href="https://github.com/apache/libcloud">github git repository</a>*
and make your changes</li>
-<li>Create a new branch for your changes:<code>git checkout -b jira_issue_id_change_name</code></li>
+<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>
+<li>Fork libcloud <a href="https://github.com/apache/libcloud">github git repository</a>*
+and make your changes</li>
+<li>Create a new branch for your changes:
+  <code>git checkout -b jira_issue_id_change_name</code></li>
 <li>Make your changes</li>
-<li>Write tests for your modifications and make sure that all the tests still pass.
For more informations about running the tests refer to the <a href="/testing.html">Testing</a>
page.</li>
+<li>Write tests for your modifications and make sure that all the tests still
+pass. For more informations about running the tests refer to the
+<a href="/testing.html">Testing</a> page.</li>
 <li>Create a patch with your changes</li>
-<li>git (format-patch): <code>git format-patch --no-prefix --stdout trunk &gt;
patch_name.patch</code></li>
-<li>git (diff): <code>git diff --no-prefix trunk your_branch &gt; patch_name.patch</code></li>
+<li>git (format-patch):
+ <code>git format-patch --no-prefix --stdout trunk &gt; patch_name.patch</code></li>
+<li>git (diff):
+ <code>git diff --no-prefix trunk your_branch &gt; patch_name.patch</code></li>
 <li>svn: <code>svn diff &gt; patch_name.patch</code></li>
 <li>Attach patch to the ticket you have created</li>
-<li>Wait for your patch to be reviewed and / or accepted</li>
+<li>Wait for your patch to be reviewed and iterate on any potential feedback</li>
 </ol>
 <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>
+<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>
 <h3 id="multiple_python_version">Supporting Multiple Python Versions</h3>
 
@@ -135,7 +147,8 @@ include extra code to make sure it works
 <p>Some examples:</p>
 <h4 id="context-managers">Context Managers</h4>
 <p>Context managers aren't available in Python 2.5 by default. If you want to use
-them make sure to put <code>from __future__ import with_statement</code> on top
of the file where you use them.</p>
+them make sure to put <code>from __future__ import with_statement</code> on top
of the
+file where you use them.</p>
 <h4 id="exception-handling">Exception Handling</h4>
 <p>There is no unified way to handle exceptions and extract the exception object
 in Python 2.5 and Python 3.x. This means you need to use a
@@ -152,16 +165,19 @@ in Python 2.5 and Python 3.x. This means
 <h4 id="python-3">Python 3</h4>
 <p>You can find a lot of utility functions which make code easier to work with 2.x
 and 3.x in <code>libcloud.utils.py3</code> module.</p>
-<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>
+<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>
 <li>Make sure edited file doesn't contain any trailing whitespace</li>
-<li>Docstrings need to follow the conventions described on the <a href="/docstring-conventions.html">Docstring
Convetions</a> page</li>
+<li>Docstrings need to follow the conventions described on the
+<a href="/docstring-conventions.html">Docstring Convetions</a> page</li>
 </ol>
-<p>You can verify that your modifications don't break any rules by running the <code>pep8</code>
script - <code>pep8 libcloud/edited_file.py</code>.</p>
+<p>You can verify that your modifications don't break any rules by running the
+<code>pep8</code> script - e.g. <code>pep8 libcloud/edited_file.py</code>.</p>
       
     </div>
 



Mime
View raw message