Author: tomaz
Date: Sat Oct 29 00:01:26 2011
New Revision: 1190691
URL: http://svn.apache.org/viewvc?rev=1190691&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=1190691&r1=1190690&r2=1190691&view=diff
==============================================================================
--- libcloud/site/trunk/content/contributing.mdtext (original)
+++ libcloud/site/trunk/content/contributing.mdtext Sat Oct 29 00:01:26 2011
@@ -21,6 +21,12 @@ 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 ###
+
+* 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 ###
