In this Release 0.3, there are 3 different requirements. And the __third one_ is about Code Review. For this code review, we are required to review some PR from other students created. And the main purpose of this is to help improve their PR so that they can get merged. And for me, I had made two code reviews in two different PR. However, they are having a same issue.
Procedure
For the code review section. The first step I made was to check the PR that opened which means that they haven't got merged. And then I just selected one of them. The first PR I picked was called [Fix and Audit types.md]. And for the second PR I picked was called[records-and-files.md].
These two PRs had a same issue. And that is they didn't check the sentences in each paragraph carefully. Due to all of these md files generated by a Docusaurus -- a modern static website generator. And I found that each sentence that in a paragraph was break with 2 spaces which is not a normal practice in our daily life or even coding. This is a small issue because although with two spaces to break sentences, it looks good in a real webpage. However, I believe that we should fix this issue because sometimes small issues matter, especially when it comes to coding!
Here is my suggestion:
①:
②:
My Feelings
What I had found is not a huge issue but a really tiny issue. However, sometimes a tiny issue could cause a huge problem. I think I would treat this code review as a reminder to myself.
"Never miss any small details!"
Top comments (0)