This issue is created to provided an introduction of the code review function during a pull request.
When collaborating on GitHub, we are expected to read and discuss each other's code before accepting the pull request. Reviewers may kindly point out bugs or issues that need to be fixed while respecting the work of the code owners. Code reviews is a handy tool to hold a conversation on the pull requests before merging it into the main.
After generating a pull request, the code owner may request a Code review from certain team member(s). The assigned reviewers may kindly provide comments or suggestions on any line of the code. Then the reviewers will submit the code reviews. The code owner needs to go through the comments, bring up more discussion if needed, or just approve the changes. Finally the pull request can be merged to the main.
This issue is created to provided an introduction of the code review function during a pull request.
When collaborating on GitHub, we are expected to read and discuss each other's code before accepting the pull request. Reviewers may kindly point out bugs or issues that need to be fixed while respecting the work of the code owners. Code reviews is a handy tool to hold a conversation on the pull requests before merging it into the main.
After generating a pull request, the code owner may request a Code review from certain team member(s). The assigned reviewers may kindly provide comments or suggestions on any line of the code. Then the reviewers will submit the code reviews. The code owner needs to go through the comments, bring up more discussion if needed, or just approve the changes. Finally the pull request can be merged to the main.
Here is a documentation for more information on Code review - https://ubc-dsci.github.io/reproducible-and-trustworthy-workflows-for-data-science/materials/lectures/02-version-control-1.html#code-reviews-using-in-line-comments-and-suggested-code-fixes