My forked git repo: https://github.com/liutng/pdrozd-ssg
Original git repo from Piotr: https://github.com/P-DR0ZD/pdrozd-ssg
In Lab 2 I forked Piotr's GitHub repo and I added markdown language support to his project, then I tested the already-existing functions to make sure that I didn't break anything. After knowing all functions are working well, I updated the documentation accordingly. In the end, I created a Pull Request to ask Piotr to review my code and allow my code to be merged into the main branch of his repository.
In order to get my pull request accepted, I contacted Piotr on Slack asking him nicely to review my modification of the code. After his testing, he found a few indentation issues on the final output HTML, although it doesn't affect the final output, he still asked me to provide a fix to it. After having the indentation issue fixed, he finally accepted my PR and the markdown feature is added to the original repository.
During this lab I noticed that I made 2 mistakes, the first one is the fact that I neglected the part where we are supposed to create an issue branch first before we start coding, which means I directly modified the main branch on my forked repository which violates the git flow of how functions should be added, so I had to backup my code and delete the forked repository to fork it again. The second issue I had was that I didn't read his code carefully which causes my indentation issue.
The lesson I learned from this lab is that, as software engineers, we should always read the documentation carefully, because most of the software requirements are conducted through documents, if we don't read it carefully, we will have to rework a lot which takes a toll on our working efficiency.
Also Piotr forked my repo and added functions to it. During the testing of his code, I found an issue about the input file of md, after talking to him on Slack, I found out it was an issue with the extension of the testing files, after fixing the issue and having the existing functions tested without any problem, I accepted his Pull Request and annotated the PR with some detail information.
Top comments (0)