Author: tomaz
Date: Sat Jun 8 04:30:39 2013
New Revision: 1490915
URL: http://svn.apache.org/r1490915
Log:
Fix style, break on 80 characters.
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=1490915&r1=1490914&r2=1490915&view=diff
==============================================================================
--- libcloud/site/trunk/content/contributing.mdtext (original)
+++ libcloud/site/trunk/content/contributing.mdtext Sat Jun 8 04:30:39 2013
@@ -4,27 +4,39 @@ Title: Contributing
This pages explains how you can contribute to the libcloud project.
-Keep in mind that all kind of contributions are welcome (ideas, code, tests,
documentation, examples, ...).
+Keep in mind that all kind of contributions are welcome (ideas, code, tests,
+documentation, examples, ...).
<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)
- 2. Fork libcloud [github git repository](https://github.com/apache/libcloud)*
and make your changes
- 1. Create a new branch for your changes:`git checkout -b
jira_issue_id_change_name`
- 2. Make your changes
- 3. Write tests for your modifications and make sure that all the tests still
pass. For more informations about running the tests refer to the
[Testing](/testing.html) page.
- 3. Create a patch with your changes
- 1. git (format-patch): `git format-patch --no-prefix --stdout trunk >
patch_name.patch`
- 2. git (diff): `git diff --no-prefix trunk your_branch > patch_name.patch`
- 3. svn: `svn diff > patch_name.patch`
- 4. Attach patch to the ticket you have created
- 5. Wait for your patch to be reviewed and / or accepted
+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)
+2. Open a new issue on the
+[bug tracker](https://issues.apache.org/jira/browse/LIBCLOUD) (JIRA)
+3. Fork libcloud [github git repository](https://github.com/apache/libcloud)*
+and make your changes
+ 1. Create a new branch for your changes:
+ `git checkout -b jira_issue_id_change_name`
+ 2. Make your changes
+4. Write tests for your modifications and make sure that all the tests still
+pass. For more informations about running the tests refer to the
+[Testing](/testing.html) page.
+5. Create a patch with your changes
+ 1. git (format-patch):
+ `git format-patch --no-prefix --stdout trunk > patch_name.patch`
+ 2. git (diff):
+ `git diff --no-prefix trunk your_branch > patch_name.patch`
+ 3. svn: `svn diff > patch_name.patch`
+6. Attach patch to the ticket you have created
+7. Wait for your patch to be reviewed and iterate on any potential feedback
<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`
+* 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`
<h3 id="multiple_python_version">Supporting Multiple Python Versions</h3>
@@ -37,7 +49,8 @@ Some examples:
#### Context Managers
Context managers aren't available in Python 2.5 by default. If you want to use
-them make sure to put `from __future__ import with_statement` on top of the
file where you use them.
+them make sure to put `from __future__ import with_statement` on top of the
+file where you use them.
#### Exception Handling
@@ -59,13 +72,16 @@ For example:
You can find a lot of utility functions which make code easier to work with 2.x
and 3.x in `libcloud.utils.py3` module.
-*Note: If you want you can also use SVN repository, but git and github make
branching and contributing a bit easier.*
+*Note: If you want you can also use SVN repository, but git and github make
+branching and contributing a bit easier.*
<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
3. Make sure edited file doesn't contain any trailing whitespace
-4. Docstrings need to follow the conventions described on the [Docstring
Convetions](/docstring-conventions.html) page
+4. Docstrings need to follow the conventions described on the
+[Docstring Convetions](/docstring-conventions.html) page
-You can verify that your modifications don't break any rules by running the
`pep8` script - `pep8 libcloud/edited_file.py`.
+You can verify that your modifications don't break any rules by running the
+`pep8` script - e.g. `pep8 libcloud/edited_file.py`.
