Skip to content
This repository has been archived by the owner on Jul 29, 2018. It is now read-only.

Latest commit

 

History

History
31 lines (25 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

31 lines (25 loc) · 1.4 KB
Raw

Contributing

  • Documentation on how to bootstrap the project -- among other things -- can be found in the /doc directory.
  • Check out the project wiki for some architecture information.
  • Bugs and other concerns should be filed in a GitHub issue so that anyone can help answer it.

Code style

This project will use a loose variation of PEP8.

Basically:

  • Use 4 spaces to indent. This is a bit old-school, but is highly recommended since most other Python projects use four spaces; abiding by this makes it easier to copy code in from other projects.
  • No hard restriction on line length, though 70 to 100 chars is probably good.
  • Files should use UTF-8 and include a # coding=utf-8 header if they contain non-ASCII charcters.
  • PEP8 is basically just there for guidance, it is not the law of the land. Just make sure you don’t do anything crazy (and if you do, comment your code) and leave it generally readable.

If you’re super ambitious, you should try PyLint, which will check your code for style AND also analyze your code for syntax errors and bad imports and other things. A good sanity check that goes way beyond code style.