Code Review
11 likes1,194 views
The document discusses code review practices at the presenter's team. It covers basic concepts like broken window theory and technical debt. It then details the team's Git and Jira processes, coding standards using PHP CodeSniffer, and code review steps involving checking code, unit tests, and identifying inefficiencies and improvements. The concepts discussed will become obsolete when applications can self-improve by writing new code to meet business needs without human involvement.
Code Review
- 1. Code Review
- 2. hello! I am Hoang Ngoc Tu I am here to present how my team is doing code review. You can find me at tuhoang.me
- 3. 1. Basic Concepts Let’s start with some classic theories
- 4. Broken Window A criminological theory that a small damage will lead to a system corruption.
- 5. Technical Debt We will spend a big extra effort eventually for a small shortcut now. Every minute spent on not-quite-right code counts as interest on that debt.
- 6. Even the best will make mistakes Most of the effort we spend on code, we spend fixing it.
- 7. ““Code chạy được chưa chắc được chạy.” - Nguyễn Thế Điền(A developer in my team)
- 8. ““Code reviews are the single biggest thing you can do to improve your code.” - Jeff Atwood, codinghorror.com
- 9. Our Jira process In Progress Code Review Ready To Merge
- 10. Our code review steps git code unit test
- 11. 2. Civilized Git Process I have a separated presentation about this topic.
- 12. Follow the civilized git branching model Commit often, Perfect later - your branch must be “perfect” to be reviewed: ○ reset, re-committed with proper meaningful commits ○ start from the correct base Prefix your commit messages with your JIRA ticket Civilized Git Process
- 13. 3. Review the Code If the programmers like each other, they play a game called “pair programming”. And if not, then the game is called “code review”. .. er .. hmm .. okay .. I don’t like you ^_^
- 15. Coding Standards For most Magento projects Zend Coding Standard Magento Coding Standard ECG Codesniffer Coding Standard For general PHP projects Framework-specific standard PSR-1 PSR-2
- 16. ECG Codesniffer Coding Standard It is created by Magento Expert Consulting Group. Automatically check some common Magento and PHP coding issues, like: raw SQL queries SQL queries inside a loop direct instantiation of Mage and Enterprise classes unnecessary collection loading excessive code complexity use of dangerous functions use of PHP superglobals and many others.
- 17. Basic Principles MVC - yes, put your code to the correct place DRY - Don’t Repeat Yourself SRP - Single Responsibility Principle KISS - Keep It Simple, Stupid!
- 19. Code Readability is King! A program that runs perfectly but is unchangeable because it has low readability is significantly less valuable than a clean and clear program with some minor bugs that can easily be found and fixed.
- 21. 4. Unit Testing I have a separated presentation about this topic.
- 23. Let’s review some concepts Broken Window Theory Technical Debt Concept git -> code -> unit test Coding Standards PHP_Codesniffer with ECGDRY SRP KISS Commit often, Perfect later, but before Review Readability is King
- 24. When will those concepts be obsolete? When the application become an AI. It can analyze new business requirement and write new code for itself to self-improve. Probably it will happen in next 20 years.
- 25. thanks! Any questions? You can find me at tuhoang.me
- 26. Credits Special thanks to all the people who made and released these awesome resources for free: Presentation template by SlidesCarnival Photographs by WallHaven