Skip to content

Latest commit

 

History

History
87 lines (76 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

87 lines (76 loc) · 3.19 KB
Raw

Welcome

This document specifies how to contribute to the repository.

Table Of Contents

Contributing code

Contributing a new program

When adding a new program please remember:

  • Create a new folder named after the title of the idea inside its category folder
  • Add a shebang line (i.e. #!/usr/bin/env python3)
  • Add a module docstring containing the title and the description of the idea from Idea Bag 2
  • Add ways to both import the program and to run it individually
  • If possible, try using only modules from the standard library
  • All rules for contributing to existing programs

Contributing to an existing program

When improving a program please follow these rules:

  • Always add docstrings
  • Use comments for everything not self explanatory
  • Keep the Zen of Python in mind
  • Before commiting check your code for codestyle issues

The Zen of Python

The Zen of Python are some generall suggestions on how to write python code.

You can view it by using

import this

inside the python shell.

The Zen of Python, by Tim Peters

Beautiful is better than ugly.

Explicit is better than implicit.

Simple is better than complex.

Complex is better than complicated.

Flat is better than nested.

Sparse is better than dense.

Readability counts.

Special cases aren't special enough to break the rules.

Although practicality beats purity.

Errors should never pass silently.

Unless explicitly silenced.

In the face of ambiguity, refuse the temptation to guess.

There should be one-- and preferably only one --obvious way to do it.

Although that way may not be obvious at first unless you're Dutch.

Now is better than never.

Although never is often better than right now.

If the implementation is hard to explain, it's a bad idea.

If the implementation is easy to explain, it may be a good idea.

Namespaces are one honking great idea -- let's do more of those!

Codestyle

In general, all programs should follow the PEP 8 styleguide. However this is only a suggestion. Just try to make your code as readable and understandable as possible. For example do not shorten your code to make each line fit into 80 characters like described in PEP 8. Instead only shorten your lines if the code is still readable afterwards.

To automatically check for PEP 8 complience use: