Manual:Pywikibot/Development/Guidelines

this is a page for helping new people who wants to help and improve pywikibot

Follow pep8
These are some standards for writing codes

Documentation
Don't forget to update the documentation both in mediawiki.org and in the codes.

for adding the documentation you need to add it at the top of the class or file you're working on it as an example:

Test via pyflakes
pyflakes is an tool to check correct usage of variables in codes for example if you define a variable and dont' use it (or don't define a variable and use it) it returns error for you.

you can easily install and run the check

Miscellany

 * Use "bot" instead of "robot" in naming variables, documentation, etc.
 * Don't use tab character, use 4 spaces instead