Patched /tmp/tmpzq_on4sk/style.md

style.md

@@ -0,0 +1,62 @@
+# Code Style Guidelines
+
+## 1. Naming Conventions
+- Use clear, descriptive names for variables, functions, and classes.
+- Follow camelCase for variables and functions, PascalCase for classes.
+- Use UPPER_CASE for constants.
+- Prefix private members with an underscore (e.g., _privateVariable).
+
+## 2. Code Structure
+- Keep functions short and focused on a single task.
+- Limit line length to 80-100 characters for improved readability.
+- Use consistent indentation (preferably 2 or 4 spaces).
+- Group related code blocks together.
+- Follow the DRY (Don't Repeat Yourself) principle to avoid code duplication.
+
+## 3. Documentation
+- Include clear, concise comments for complex logic or algorithms.
+- Use docstrings for functions, classes, and modules, describing purpose, parameters, and return values.
+- Keep documentation up-to-date with code changes.
+- Use TODO comments for planned improvements or known issues.
+
+## 4. Error Handling
+- Use try-catch blocks for error-prone operations.
+- Provide informative error messages.
+- Log errors with appropriate severity levels.
+- Handle exceptions at the appropriate level of abstraction.
+
+## 5. Performance
+- Optimize critical paths and frequently executed code.
+- Use appropriate data structures for efficient operations.
+- Minimize database calls and optimize queries.
+- Implement caching strategies where applicable.
+
+## 6. Security
+- Validate and sanitize all user inputs.
+- Use parameterized queries to prevent SQL injection.
+- Implement proper authentication and authorization mechanisms.
+- Follow the principle of least privilege for access control.
+- Keep sensitive data encrypted at rest and in transit.
+
+## 7. Testing
+- Write unit tests for individual components and functions.
+- Implement integration tests for system interactions.
+- Maintain a high test coverage for critical code paths.
+- Use mock objects and stubs for testing dependencies.
+
+## 8. Version Control
+- Write clear, descriptive commit messages.
+- Use feature branches for new developments.
+- Perform code reviews before merging into the main branch.
+- Keep commits small and focused on a single change.
+
+## 9. Code Reusability
+- Create modular and reusable components.
+- Use design patterns appropriately to solve common problems.
+- Implement interfaces and abstract classes for flexibility.
+
+## 10. Maintainability
+- Refactor code regularly to improve readability and structure.
+- Remove dead code and unused variables.
+- Keep dependencies up-to-date and manage them effectively.
+- Document architectural decisions and system design.