summaryrefslogtreecommitdiff
path: root/.github/copilot-instructions.md
blob: f10cd4695ce6036f2bd44142589103e8f1fbbdda (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
---
applyTo: "**/*.py"
---

# Project general coding standards

## Naming Conventions

- Use snake_case for variable and function names.
- Use CamelCase for class names.
- Follow PEP 8 style guidelines.
- Include type hints for function parameters and return types.
- Always write doc strings for all modules, classes, functions, and methods using google docstring style. Use typing in doc strings.
- Prefix private class members with underscore (\_).
- Use ALL_CAPS for constants.
- Use newest coding style which is supported by the used Python version.

## Error Handling

- Use try/except blocks for async operations.
- Always log errors with contextual information.