summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorRobert Honz <exislow+github@gmail.com>2025-07-01 14:36:37 +0200
committerRobert Honz <exislow+github@gmail.com>2025-07-01 14:36:37 +0200
commit395771a93904389832e0079531f53db90fdd1ac6 (patch)
tree2033002cb3d1f280b325e9acc2bdf56039bb7a45 /.github
parentd8a6c26d658f46040b7fcdc3097ce25cc196f67b (diff)
downloadtidal-dl-ng-395771a93904389832e0079531f53db90fdd1ac6.tar.gz
refactor(guidelines): ✨ Update coding standards for type annotations and add PEP references
* Clarified type annotations usage for function parameters, return types, and variables. * Added guidelines for using blank lines, coroutines, and string interpolation as per PEP standards.
Diffstat (limited to '.github')
-rw-r--r--.github/copilot-instructions.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
index 472850f..c890c0c 100644
--- a/.github/copilot-instructions.md
+++ b/.github/copilot-instructions.md
@@ -19,8 +19,12 @@ applyTo: "**/*.py"
## Coding Guidelines
-- Use type annotations for function parameters, return types and variables.
+- Use type annotations / hints for function and method parameters, return types and variables. Follow PEP 484.
- Use newest coding style which is supported by the used Python version.
+- Use blank lines to keep code organized and readable.
+- Follow PEP 492 – Coroutines with async and await syntax
+- Follow PEP 498 – Literal String Interpolation
+- Follow PEP 572 – Assignment Expressions
## Code Documentation