New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Code review guidelines and best practices. #368

Open

tylercherpak opened this issue Jun 23, 2021 · 0 comments

Assignees

Contributor

tylercherpak commented Jun 23, 2021

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

aaemnnosttv self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment