Code Review

r-knowledge git

How to complete a code review at NN using GitHub

Yonghyeon Kweon and Meng Gao
01-12-2023

This content was presented to Nelson\Nygaard Staff at a Lunch and Learn webinar on Thursday, January 12th, 2023, and is available as a recording here and embedded below.

Introduction

The purpose of code review is for quality assurance of the code and Github review allows collaborators to comment on each line of codes. If you are a main code developer, follow instruction under For Developer, and if you are a reviewer, follow instruction under For Reviewer. After finishing Coding & Review, don’t forget to fill out the survey!

Instruction

For Developer

Step 1

create Project Repository in PW github

Step 2

Give an access to your Code Buddy

Setting > Collaborators and teams > Add people (role: Admin)

Step 3

create an branch and push your code (make sure that you are not pushing to the master/main branch) to open Pull Request.

For Reviewer

Step 1

go to the developer’s commit

Step 2

Click + button and started a review

Step 3

Finish your Review

There are three possible status:

What’s next after Code Review?

  1. Submit a survey for your code review (for both developer and reviewer)

  2. Check survey result