Code Checklist

Code Review Checklist

(inspired by https://www.fafadiatech.com/blog/pro-tip-code-review-checklistdjango-covered/)

Structure and documentation

• Imports are sorted according to convection ( run PEP8 )
• Code conforms to PEP8 ( run flake8 )
• Docstring in PEP8
• Code has tests
• Code coverage is high (run coverage)
• Clear READEME.md

Minor

• No typos and grammatical errors in code

Variables

• No unused variable
• Variables have clear and explicit names

Clean code

• Classes should be small
• Functions should be small
• Avoid Duplication
• Code is obvious for other programmers

Performance

• Styling is working
• All functionality should be working properly
• Have try-except block to handle errors

Tests

• Tests cover normal case
• Tests cover border case
• Tests cover extreme case