Author: tomaz
Date: Sat Oct 29 00:04:54 2011
New Revision: 1190694
URL: http://svn.apache.org/viewvc?rev=1190694&view=rev
Log:
CMS commit to libcloud by tomaz
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=1190694&r1=1190693&r2=1190694&view=diff
==============================================================================
--- libcloud/site/trunk/content/contributing.mdtext (original)
+++ libcloud/site/trunk/content/contributing.mdtext Sat Oct 29 00:04:54 2011
@@ -6,7 +6,7 @@ This pages explains how you can contribu
Keep in mind that all kind of contributions are welcome (ideas, code, tests,
documentation, examples, ...).
-### Process ###
+<h3 id="process">Process</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)
1. Open a new issue on the [bug
tracker](https://issues.apache.org/jira/browse/LIBCLOUD) (Jira)
@@ -21,15 +21,14 @@ Keep in mind that all kind of contributi
4. Attach patch to the ticket you have created
5. Wait for your patch to be reviewed and / or accepted
-
-#### Things To Keep In Mind ###
+<h3 id="things_to_keep_in_mind">Things To Keep In Mind</h3>
* Any non-trivial change must contain tests
* All the functions and methods must contain
[pydoc](http://codespeak.net/~mwh/pydoctor/) docstrings which are used to
generate API documentation. You can find a lot of examples of docstrings in the
existing code e.g. - `libcloud/compute/base.py`
*Note: If you want you can also use SVN repository, but git and github make
branching and contributing a bit easier.*
-### Style Guide ###
+<h3 id="style_guide">Style Guide</h3>
1. We follow [PEP8 Python Style
Guide](http://www.python.org/dev/peps/pep-0008/)
2. Use 4 spaces for a tab
