Code review guidelines
Anup Raaj (InstaPrepsAi)
Founder, CEO & CTO @ InstaPrepsAi || Startup and Technology Architect || Confidence Building Using Ai
Looking for critical review to make it better.
Code review is one of the most critical part of software development lifecycle. It gives great learning opportunity to reviewer and reviewee. Apart from deep knowledge it also nurtures good mentoring and behavioural skills. Non of the involved person should have a negative feeling about reviewing or getting reviewed any code.
Look for the following( in order):
- Dependency review: Change should not break any other feature or product. A good number of times reviewed code crashes in production. Bad part is it hurts stable features put in marketing and campaigns resulting in huge monetary and credibility loss. That's why this is the first rule of code review.
- Code complexity: Code complexity is directly linked to consumer experience. A good developer contributes to page speed and so the experience which affects everything (Future of product, adoption and revenue).
- Extendibility: A market fit product requires improvement, A/B testing and feature additions flexibility. A developer is the best person to ship iterations faster. Keep enough room to accommodate changes in time.
- Maintainability: Of course anything in use needs maintenance. May be due to upgrades, may be due to some third party pulled support.
- Scalability: Yeah if you pulled a market fit product users will come 1, 10, 100, 1000 and 10k (k>1000). Be prepared for that.
- Style guidelines: Most of the languages give freedom to developers to follow any naming convention, communication guidelines and editor preferences. But one team should follow a particular style to maintain consistency.
Please review this code review guidelines if you find time. Thanks in advance :)#