dimitritholen
dimitritholen / best-practices
- **MANDATORY**: Follow PEP 8 style guide for Python code to maintain readability and consistency. - **REQUIRED**: Docstrings are **MANDATORY** for all public modules, functions, classes, and methods. - **MUST** use four spaces per indentation level.
dimitritholen / documentation
- **MANDATORY**: All Python functions and methods **MUST** have docstrings. - **REQUIRED**: Every module **MUST** contain a module-level docstring explaining the purpose and usage of the module. - Documentation **MUST** be written in English using clear, precise, and easy-to-understand language.
dimitritholen / pep8
- **ALWAYS** adhere to the PEP 8 guideline for maximum line length of 79 characters for code and 72 for comments. - **MANDATORY** use of `snake_case` for function and variable names. - **MUST** use `CapWords` convention for class names.