Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

45 lines (26 loc) · 1.08 KB
Raw

Requirements

  • Python 3.7+

  • QT5: https://qt.io

    You can install it from your system package manager on GNU/Linux

    On macOS:

    brew install qt

Setting up the development environment

  1. Install poetry

  2. Create a virtual environment

python3 -m venv venv
source venv/bin/activate
  1. Install dev dependencies
poetry install

Coding Style

All code (including tests) must pass flake8 and pylint checks.

Please follow PEP8 with a few modifications:

  1. Preferable line length is under 80 characters per line, hard limit is 100 characters per line. If you are going to break lines, break at the 80th character

  2. Strings are single quoted, unless there are single quotes in the string, then they are double quoted.

    2.1 Multi-line string literals and docstrings are to be surrounded with triple double quotes (""")

  3. Doc-strings should follow the Google doc-string style: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html