Update CONTRIBUTE.md to provide Python style guide as good as the information that Wilas has emailed me.

[cniswander]

In my correspondence with Wilas, it seems that his preferred Python coding style has evolved considerably since he wrote the original convert_2_scancode.py code. When I modified convert_2_scancode.py, I unfortunately targeted the old style instead of Wilas' newer style preferences.

I suggest:

• put most of the existing vbkick coding style guide into a 'bash scripting coding style guide' section of CONTRIBUTE.md
• add a new section: 'Python Coding Style Guide'

The new section can be based largely on information Wilas emailed me. Maybe it will be something like:

---

Python Coding Style Guide

The plan is to evolve existing Python code towards the following style, and to write new code in this style.

Most important:

1. Conform in all respects to PEP 8. (see http://legacy.python.org/dev/peps/pep-0008/)

Of secondary importance:

1. We also recommend you read and try to apply:
   • http://www.jeffknupp.com/blog/2012/10/04/writing-idiomatic-python/
   • http://nbviewer.ipython.org/github/rasbt/python_reference/blob/master/not_so_obvious_python_stuff.ipynb
2. Try to keep the maximum indent level to three. "If more is needed, then probably I'm doing something wrong."

[wilas]

Thanks @cniswander. Are you happy to modify CONTRIBUTE.md file or do you want me to do this ? :)

[cniswander]

Either of us could add the Python style guide part, if you approve of the draft that I posted in this Issue.

But you should handle anything relating to the bash style guide.

On 05/26/2014 02:54 AM, Kamil Wilas wrote:

Thanks @cniswander https://github.com/cniswander. Are you happy to modify CONTRIBUTE.md file or do you want me to do this ? :)

— Reply to this email directly or view it on GitHub https://github.com/wilas/vbkick/issues/40#issuecomment-44174405.

Obligatory signature: This email address is for the use of my friends and associates only -- please don't publish it.

[wilas]

f6bd6dfe0ae509ae28ab9d88dc1e114c9db5f9ad adds the Python Coding Style Guide section.