From eda5ab92c010822f638047a657bad6b8eaba3e41 Mon Sep 17 00:00:00 2001 From: Robert Honz Date: Tue, 1 Jul 2025 10:08:46 +0200 Subject: [PATCH] =?UTF-8?q?feat:=20=E2=9C=A8=20Add=20project=20coding=20st?= =?UTF-8?q?andards=20for=20Python?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Introduced guidelines for naming conventions and error handling. * Specified the use of `snake_case` for variables, `CamelCase` for classes, and PEP 8 compliance. * Emphasized the importance of type hints and docstrings in code documentation. --- .github/copilot-instructions.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..94aae70 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,20 @@ +--- +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. +- Write docstrings for all public modules, classes, functions, and methods using google docsrting style. +- Prefix private class members with underscore (\_) +- Use ALL_CAPS for constants + +## Error Handling + +- Use try/except blocks for async operations +- Always log errors with contextual information