Writing code that works is only a small part of good programming. It is equally important that you write code that is easy for other programmers to read and understand.
Step-by-step guide
- Follow the PEP-008 style guide: https://www.python.org/dev/peps/pep-0008/. It's not as complicated as it looks!
- Use pylint: http://www.pylint.org/. This great little package will give you detailed feedback about how to make your code beautiful and useful.
- Write informative comments. Don't just re-iterate what the code does: explain why you wrote the code the way that you did.
- Ask for code reviews! If you're not ready to submit a pull request, but want some feedback on your code, start a code review through Crucible.
Related articles