Contributing - nortikin/sverchok GitHub Wiki
Contributing to Sverchok
Please follow our coding conventions. Look at the existing nodes for suggestions on formatting and naming conventions. If you are relatively new to Python, check this readability counts video from pycon
pep-8 and pylint
- read pep 8 again (Python's style guide, not sverchok's style guide).
- Use a pep8 checker or pylint - it's like someone watching over your shoulder trying to get you to write more consistent code.
We'll scan pull requests and suggest improvements if we have to. Nicer looking code is a lot more pleasant to debug. We follow pep8 mostly. Line-length however is not something we obsess about. Make your lines as long as you need.
We also ignore smaller style issues. These are some of the pylint ignores you'll find in the codebase:
# pylint: disable=w0122
# pylint: disable=w0123
# pylint: disable=w0141
# pylint: disable=w0613
# pylint: disable=C0326
What do those mean?
| code | meaning | controversial? |
|---|---|---|
| w0122 | Use of exec | depends, we will try to provide an alternative if possible |
| w0123 | eval-used | depends, we will try to provide an alternative if possible |
| w0141 | Used builtin function | this means you might have used map or filter |
| w0613 | unused-argument | often the context argmenent in draw_buttons is unused.. |
| C0326 | bad-whitespace | sometimes whitespace in comma separated content is a bit annoying.. |