Code Style

This document aims to provide clear instructions on how to write clean, readable, and maintainable Python code. Adhering to these guidelines will ensure consistency across the codebase and foster collaboration among contributors. Maintaining a consistent code style is crucial for the readability and maintainability of a Python project.

We enforce most of the following guidelines in our Continuous-Integration pipeline that check the code automatically.

1. Installation

Before contributing to the project, make sure you have the necessary tools installed for code style enforcement. We utilize pre-commit to automate code checks before committing changes.

2. Code Formatting

Consistent code formatting enhances readability and reduces unnecessary debates about style. We use Ruff as Python code formatter. It automatically formats your code to adhere to the project's style guidelines.

3. Naming Conventions

While we don't enforce strict naming conventions, we encourage compliance with PEP8 and the Google Python Style Guide for consistency. Descriptive names and adherence to conventions improve code clarity.

4. Indentation and Whitespace

We follow the Python standard of using 4 spaces for tab indentation. Do not include any trailing whitespace at the end of lines.

5. Comments and Documentation

Effective comments and docstrings are vital for code understanding. Use comments to explain complex logic and docstrings to describe functions, classes, and modules. Following good documentation practices ensures code is understandable to others.

6. Code Structure and Organization

Maintain a logical structure within files, grouping related functions and classes. Consider the readability of your code and strive for modular, well-organized files.

Used Icons

🐙 GitHub | 💠 git | 📝 File | 💻 Command Line