Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.97 KB

style.md

File metadata and controls

53 lines (37 loc) · 1.97 KB

Style Guidelines

This software is intended to be a collaborative work, and contributions are welcome from anyone, but in order to maintain the quality of the program, there are guidelines in place for code style.

Code Style

  • Indentation: 4 spaces

  • Cases:

    • Modules: snake_case

    • Variables and properties: snake_case

    • Constants: SCREAMING_SNAKE_CASE

    • Functions: camelCase

    • Classes: PascalCase

  • Typing: where it is reasonable, type hints should always be included on function definitions. The project should remain compliant with MyPy.

  • Modules, classes and functions should be documented with docstring. If you use VS Code, a configuration for the Python Docstring Generator extension is provided which should be used automatically. For reference, this file is provided in resources/docstring_template.mustache. Functions that are documented by a parent class shouldn't be documented again.

  • Spell checking your code is recommended. Your language should be set to En-US.

  • You should list yourself as the author of any module you work on, including your name and Discord username (if you have one). Also add yourself to common/consts.py to appear in the credits. If your code is user-facing (eg a plugin or device) or will be used by contributors (eg a control surface), you should add some information on it to these docs, as well as the standard docstrings within the code.

Development Environment

  • I'd recommend working on the project using VS Code, with the recommended extensions installed. This should help ensure that the code is safe and clean. You can use any editor you see fit, but it may be more difficult to maintain code style requirements.

  • You should work on this project within a virtual environment in order to avoid the risk of dependency conflicts. Make sure you install the dependencies from requirements.txt.