summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorRobert Honz <exislow+github@gmail.com>2025-07-01 10:08:46 +0200
committerRobert Honz <exislow+github@gmail.com>2025-07-01 10:08:46 +0200
commiteda5ab92c010822f638047a657bad6b8eaba3e41 (patch)
tree6f645b712b675ae718e2952d5f1f6bd008aff010 /.github
parentf546b43101f8ebf4346cf436286682d7b4c80560 (diff)
downloadtidal-dl-ng-eda5ab92c010822f638047a657bad6b8eaba3e41.tar.gz
feat: ✨ Add project coding standards for Python
* 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.
Diffstat (limited to '.github')
-rw-r--r--.github/copilot-instructions.md20
1 files changed, 20 insertions, 0 deletions
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