diff options
Diffstat (limited to '.github/copilot-instructions.md')
| -rw-r--r-- | .github/copilot-instructions.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index f10cd46..472850f 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -9,13 +9,21 @@ applyTo: "**/*.py" - 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. + +## Coding Guidelines + +- Use type annotations for function parameters, return types and variables. +- Use newest coding style which is supported by the used Python version. + +## Code Documentation + +- Always write doc strings for all modules, classes, functions, and methods using google docstring style. +- Use typing in doc strings. +- Use short inline comments to explain complex logic. |