Code review guidelines and best practices.
tylercherpak opened this issue · 0 comments
tylercherpak commented
We should add a section of the best practices that talks about how to do proper code review and make suggestions.
Gitlab has a good example of this and potentially we can link directly to it: https://docs.gitlab.com/ee/development/code_review.html#everyone
Big things I would like to see added:
- Understand that all code bases are the combination of many technical trade offs and business decisions
- Be kind
- Remember its the code being reviewed and not you
- Try to be thorough with your review to reduce iterations
- Make sure to let the author know if changes are required
- Ask for clarification if you don't understand something