Manual:Pywikibot/Development/Guidelines

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

Reporting a bug
You have seen a problem in pywikibot? it's not the end of the world, just keep calm and report it in bugzilla, the important notes for reporting bugs are:
 * Get output of  and amend it to your report
 * Include exact steps to reproduce the bug
 * Include the difference between expected output and real output

Bug triage
If you like to help pywikibot is not just writing codes! you can help easily by categorizing, confirming, prioritizing bugs. Just go to the browse project in bugzilla and get the list.

Making a patch
Read Manual:Pywikibot/Gerrit.

Follow pep8
These are some standards for writing codes - pep8 is mainly about writing your codes in a way that would be easy to read. Some of the most important things are:
 * Add a space before and after an equal sign ("=") when you want to define a variable
 * Don't make very long lines, split them into several lines based on what they are
 * Indentation are really important about readability of code, use it properly, use 4 spaces instead of tab character
 * Each import has to be in a separated line for example:
 * if you want to import a group of classes, make a blank line. for example:

Follow pep257
This standard is mainly about docstrings (documentation inside codes). There are two kinds of docstring, one-line docstring and multi-line docstring. A one-line docstring has to be like: and a multi-line docstring has to be like: Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description. The summary line may be used by automatic indexing tools; it is important that it fits on one line and is separated from the rest of the docstring by a blank line.

Naming style

 * Names of classes has to be CapWord (use DataPage instead of Datapage, datapage or data_page)
 * Names of functions and methods has to be lowercase with underscores for better readability (e.g. set_label instead setLabel, or SetLabel)
 * Names of errors has to be CapWord with "Error" suffix (like NoPageError)

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 or function you're working on it as an example:

It's really important to list all of usable methods of a class or arguments a script.

Using decorator is highly recommended. There is a help page about them in python.org help wiki

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

You can easily install and run the check, there is a manual for it

Miscellany

 * Use "bot" instead of "robot" in naming variables, documentation, etc.
 * Don't use tab character, use 4 spaces instead
 * If you want to remove a part of code, don't comment it out. Just remove it.
 * Don't use /r (carriage return character) in codes, Some code editors add it automatically, check and delete them.