- Ensure your code is clean and well-documented.
- Follow PEP 8 style guide for Python code.
- Use type hints for function signatures.
- Include docstrings for all functions and classes.
- Prefer list comprehensions over traditional loops where applicable.
- Write unit tests for all new features.
- Log at appropriate levels (INFO, WARNING, ERROR).
- Handle exceptions gracefully.
- Provide meaningful error messages.
- Handle errors and log them appropriately.
- Provide example usage for complex functions or classes.
- Keep the documentation up-to-date with code changes.
- Use Markdown for generating documentation.
- Avoid hardcoding sensitive information.
- Use environment variables for configuration.
- Optimize code for performance where necessary.
- Avoid premature optimization; focus on readability first.
- use doctest