summaryrefslogtreecommitdiff
path: root/.github/copilot-instructions.md
diff options
context:
space:
mode:
authorRobert Honz <exislow+github@gmail.com>2025-07-01 11:33:04 +0200
committerRobert Honz <exislow+github@gmail.com>2025-07-01 11:33:04 +0200
commit4dde8c819a82a763e8b5df8a843559a2aafd3e4b (patch)
tree03c68816dfb2c5d2dda04f8c0e75336f7977d589 /.github/copilot-instructions.md
parent29ffd5df4b65da9d206f31db974b7c95dffeda0d (diff)
downloadtidal-dl-ng-4dde8c819a82a763e8b5df8a843559a2aafd3e4b.tar.gz
chore: 🔧 Update coding standards and documentation guidelines
* Refined coding guidelines for clarity and structure. * Added sections for type annotations and docstring requirements. * Ensured consistency in documentation practices across the project.
Diffstat (limited to '.github/copilot-instructions.md')
-rw-r--r--.github/copilot-instructions.md14
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.