contributing.md

Contributing

• Follow PEP8 as much as you can (use pylint, default in vscode)
• Use google-style docstrings.

Naming conventions:

• PascalCase: for class names
• UPPER_SNAKE_CASE: for constants
• snake_case: for everything else

Formatting

• Use black
• Max line width of 120 characters, vscode settings:

    "python.formatting.provider": "black",
    "python.formatting.blackArgs": [
        "--line-length=120",
        "--target-version=py37",
    ],
    "editor.formatOnSave": true,

Submitting code

• Make sure the code is tested, documented, then create a draft pull request from your feature branch.