DEV Community

Kien Nguyen Chi
Kien Nguyen Chi

Posted on

Code Reviews on IPC Project

Introduction

This week, I have done 2 code reviews on classmates' pull requests on the project operated by my school Seneca College. It is an open source project - built in contents of IPC144 (Introduction To C Programming) course. You can take a look at the GitHub Repo and the website.

First Code Review

  • First, I take a look at this Pull Request #76. This commit audits and fixes the arrays.md file.
  • I take a look carefully at every changes of the pull requests and I found 2 issues that needed to be fixed.
  • First, there is a hyperlink on the line 19 displayed in the web on:
[structures](../C-Data-Structures/structures "Structures")
Enter fullscreen mode Exit fullscreen mode
  • When I try to click the link, it leads to an error link so I put a comment for the maintainer to fix that link.

  • The second issue is on line 118, there are code displayed as below:

for (i = 0; i < NGRADES; i++) {
    printf("%d" , grade[i]);
}
Enter fullscreen mode Exit fullscreen mode
  • I leave a comment that the maintainer can add int i = 0 so it would make more senses for the code.

Second Code Review

  • I take a look at this Pull Request #83. This commit audits and fixes the Operators.md file.
  • I take a closer look at changes of this pull request and I found 2 issues that needed to be fixed for better display.
  • The page is currently displayed like this:
  • Section 5 and 6 should be in code block syntax which makes the it looks similarly to the Code Block of Section 1-4.
  • I left a comment for the maintainer to fix and he successfully put them into the code blocks.
  • The page is now displayed like this:

Conclusion

This is the first time that I reviewed someone code and it is interesting to do that. The more I dig in to the open source world, I cannot deny the fact that GitHub is really useful tool for the coders to work together, add code, review code, etc. It is so convenient and I love it!

Top comments (0)