As a part of my release 0.3 for OSD600, I had to create 2 code reviews for internal Seneca College open-source projects. Both of my code reviews were for vscode-seneca-college.
My Reviews
The first review I made was for a pull request for creating a readme and contributing documents. My review comments were concerned mostly more on grammar and formatting. With documentation, some things may be unclear especially instructions for setup. This can cause a lot of confusion, especially when many people will be reading that documentation. That's why it's very important for documentation not only to be accurate but clear to the reader as well as to avoid confusion.
The second review I did was for a pull request adding a snippet for a Visual Studio Code extension. I was not really familiar with how snippets worked initially, so I had to do some reading on them before doing this review. The code in the pull request looked similar to the documentation example, and testing it seemed to function properly. My issue with the the pull request was with the terminology used in it. The term "course" seemed more appropriate to me than "Class" in that context, and the change I suggested was made.
What I learned
I learned what is possible for code reviews, they are not always purely technical or even coding related. I can help by proofreading and improving the readability of not just code contributions but documentation contributions as well. I can learn from code reviews as well. By testing code contributions and reading their related documentation, I can learn things I didn't know before. I learned what it is like on the other side of a pull request as well. Having to read other's code and provide suggestions if necessary was a much different experience than actually contributing to another's code.
Top comments (0)