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.
This commit is contained in:
@@ -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
|
||||
Reference in New Issue
Block a user